Where to download the Amazon FSx CLI for remote management on PowerShell

Link- https://docs.aws.amazon.com/fsx/latest/WindowsGuide/remote-pwrshell.html#using-rps

To start a remote PowerShell session on your file system

Connect to a compute instance that has network connectivity with your file system as a user that is a member of the delegated FSx Administrators Group that you chose when provisioning the file system.

Open a Windows PowerShell window on the compute instance.

Use the following command to open the remote session on your Amazon FSx file system. Replace FSxFileSystem-Remote-PowerShell-Endpoint with the Windows Remote PowerShell endpoint of file system that you want to administer.

PS C:\Users\delegateadmin> enter-pssession -ComputerName FSxFileSystem-Remote-PowerShell-Endpoint -ConfigurationName FsxRemoteAdmin [fs-0123456789abcdef0]: PS> If your instance is not part of the Amazon FSx AD domain, you are prompted to enter user credentials in a pop-up. If your instance is joined to the domain, you will not be asked for credentials.

You can also run Amazon FSx CLI for remote management CLI on PowerShell commands on your file system using the Invoke-Command cmdlet, described following.

The following example illustrates the syntax required when using the Invoke-Command cmdlet to run PowerShell commands on an FSx for Windows File Server file system.

PS C:\Users\delegateadmin> Invoke-Command -ComputerName amznfsxzzzzzzzz.corp.example.com -ConfigurationName FSxRemoteAdmin -scriptblock { fsx-command}

The link is here: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/remote-pwrshell.html

Can you share where you were looking in the documentation, so we can add a pointer/link in that place?

Your assumption in the follow-up is correct: there is no separate public PowerShell module to download for New-FSxSmbShare.

The similarly named components have different roles:

• AWS.Tools.FSx (and AWSPowerShell) contains client cmdlets for the Amazon FSx service API, such as Get-FSXFileSystem.
• The Amazon FSx CLI for remote management on PowerShell is a command set exposed by the managed file system through its FsxRemoteAdmin PowerShell remoting endpoint. Commands such as New-FSxSmbShare run there; they are not imported into the local PowerShell process.

For example, you can use AWS Tools for PowerShell to discover the endpoint, then use normal PowerShell remoting to run the remote commands:

$fs = Get-FSXFileSystem -FileSystemId 'fs-0123456789abcdef0'
$endpoint = $fs.WindowsConfiguration.RemoteAdministrationEndpoint

Enter-PSSession -ComputerName $endpoint -ConfigurationName FsxRemoteAdmin

Inside that long-lived administration session, confirm the command set and its exact syntax:

Get-Command -Name '*-FSx*'
Get-Command -Name New-FSxSmbShare -Syntax

For automation, execute the script block remotely instead of installing or copying a module locally:

Invoke-Command -ComputerName $endpoint -ConfigurationName FsxRemoteAdmin -ScriptBlock {
    Get-Command -Name New-FSxSmbShare -Syntax
    # Run New-FSxSmbShare here after validating its parameters.
}

Supply -Credential when the current Windows identity cannot be used for the domain authentication. The AWS documentation also requires:

• network connectivity from the Windows compute instance to the file system;
• membership in the delegated FSx administrators group; and
• an inbound security-group rule allowing TCP 5985 to the file system.

The remote session is authenticated and encrypted with Kerberos. This is distinct from the IAM credentials used by Get-FSXFileSystem to call the FSx API. Therefore, installing AWS.Tools.FSx alone will never add New-FSxSmbShare; it only helps with the control-plane/API part, including retrieving RemoteAdministrationEndpoint.

References:

• Using the Amazon FSx CLI for PowerShell
• Starting an Amazon FSx remote PowerShell session
• Managing FSx file shares with PowerShell
• Get-FSXFileSystem cmdlet