StorageGateway / Client / set_local_console_password

set_local_console_password#

StorageGateway.Client.set_local_console_password(**kwargs)#

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don’t need to know the default password to set a new password.

See also: AWS API Documentation

Request Syntax

response = client.set_local_console_password(
    GatewayARN='string',
    LocalConsolePassword='string'
)
Parameters:

  • GatewayARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • LocalConsolePassword (string) –

    [REQUIRED]

    The password you want to set for your VM local console.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) –

    • GatewayARN (string) –

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Sets the password for your VM local console.

response = client.set_local_console_password(
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    LocalConsolePassword='PassWordMustBeAtLeast6Chars.',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'ResponseMetadata': {
        '...': '...',
    },
}