Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . medialive ]

create-node-registration-script

Description

Create the Register Node script for all the nodes intended for a specific Cluster. You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere.

See also: AWS API Documentation

Synopsis

  create-node-registration-script
--cluster-id <value>
[--id <value>]
[--name <value>]
[--node-interface-mappings <value>]
[--request-id <value>]
[--role <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-id (string) The ID of the cluster

--id (string) If you're generating a re-registration script for an already existing node, this is where you provide the id.

--name (string) Specify a pattern for MediaLive Anywhere to use to assign a name to each Node in the Cluster. The pattern can include the variables $hn (hostname of the node hardware) and $ts for the date and time that the Node is created, in UTC (for example, 2024-08-20T23:35:12Z).

--node-interface-mappings (list) Documentation update needed(structure)

A mapping that's used to pair a logical network interface name on a Node with the physical interface name exposed in the operating system.

LogicalInterfaceName -> (string)

A uniform logical interface name to address in a MediaLive channel configuration.

NetworkInterfaceMode -> (string)

Used in NodeInterfaceMapping and NodeInterfaceMappingCreateRequest

PhysicalInterfaceName -> (string)

The name of the physical interface on the hardware that will be running Elemental anywhere.

Shorthand Syntax:

LogicalInterfaceName=string,NetworkInterfaceMode=string,PhysicalInterfaceName=string ...

JSON Syntax:

[
  {
    "LogicalInterfaceName": "string",
    "NetworkInterfaceMode": "NAT"|"BRIDGE",
    "PhysicalInterfaceName": "string"
  }
  ...
]

--request-id (string) An ID that you assign to a create request. This ID ensures idempotency when creating resources.

--role (string) The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.

Possible values:

• BACKUP
• ACTIVE

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

NodeRegistrationScript -> (string)

A script that can be run on a Bring Your Own Device Elemental Anywhere system to create a node in a cluster.