1. Arpio Documentation
  2. Reference Guides
  3. Arpio Configuration Tag Reference

arpio-config:fsx:ad:FileSystemAdministratorsGroup

Use a custom value for FileSystemAdministratorsGroup when an FSx for Windows file system is recovered

arpio-config:fsx:ad:FileSystemAdministratorsGroup = <group-name>

<group-name>

The value to use for the FileSystemAdministratorsGroup property of the SelfManagedActiveDirectoryAttributes structure used to recover an FSx for Windows file system that uses a self-managed Active Directory.

If the value is empty, Arpio will not send a value for FileSystemAdministratorsGroup to AWS when recovering the file system, which causes FSx to use the default group name.

Supported Resources

  • FSx for Windows file systems (self-managed Active Directory only)

Description

When recovering an FSx for Windows file system with self-managed Active Directory settings, Arpio normally uses the FileSystemAdministratorsGroup value read from the primary environment.  Sometimes you may need to use a different value in the recovery environment, for example, because the group name that was originally used is no longer present in the directory, or should no longer be used for this purpose for some other reason.

You can use this config tag to specify a different value to use for FileSystemAdministratorsGroup when Arpio recovers the tagged filesystem.  This tag only works for file systems configured to use a self-managed Active Directory.  It will be ignored for other FSx file system types.

If you use an empty value for this tag, Arpio will send no value for the FileSystemAdministratorsGroup property when it recovers the filesystem.  This causes the FSx service to use a default value.

Examples

Tag Value
arpio-config:fsx:ad:FileSystemAdministratorsGroup
MyCorpStorageGroup
arpio-config:fsx:ad:FileSystemAdministratorsGroup
 

The first example tells Arpio to recover the filesystem using MyCorpStorageGroup as the new administrators group value. 

The second example uses an empty tag value, which causes Arpio to send no value for the FileSystemAdministratorsGroup property when it recovers the filesystem.  This causes the FSx service to use its default group name for storage administration.