Panorama / Client / provision_device

provision_device#

Panorama.Client.provision_device(**kwargs)#

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

See also: AWS API Documentation

Request Syntax

response = client.provision_device(
    Description='string',
    Name='string',
    NetworkingConfiguration={
        'Ethernet0': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'DefaultGateway': 'string',
                'Dns': [
                    'string',
                ],
                'IpAddress': 'string',
                'Mask': 'string'
            }
        },
        'Ethernet1': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'DefaultGateway': 'string',
                'Dns': [
                    'string',
                ],
                'IpAddress': 'string',
                'Mask': 'string'
            }
        },
        'Ntp': {
            'NtpServers': [
                'string',
            ]
        }
    },
    Tags={
        'string': 'string'
    }
)
Parameters:

  • Description (string) – A description for the device.

  • Name (string) –

    [REQUIRED]

    A name for the device.

  • NetworkingConfiguration (dict) –

    A networking configuration for the device.

    • Ethernet0 (dict) –

      Settings for Ethernet port 0.

      • ConnectionType (string) – [REQUIRED]

        How the device gets an IP address.

      • StaticIpConnectionInfo (dict) –

        Network configuration for a static IP connection.

        • DefaultGateway (string) – [REQUIRED]

          The connection’s default gateway.

        • Dns (list) – [REQUIRED]

          The connection’s DNS address.

          • (string) –

        • IpAddress (string) – [REQUIRED]

          The connection’s IP address.

        • Mask (string) – [REQUIRED]

          The connection’s DNS mask.

    • Ethernet1 (dict) –

      Settings for Ethernet port 1.

      • ConnectionType (string) – [REQUIRED]

        How the device gets an IP address.

      • StaticIpConnectionInfo (dict) –

        Network configuration for a static IP connection.

        • DefaultGateway (string) – [REQUIRED]

          The connection’s default gateway.

        • Dns (list) – [REQUIRED]

          The connection’s DNS address.

          • (string) –

        • IpAddress (string) – [REQUIRED]

          The connection’s IP address.

        • Mask (string) – [REQUIRED]

          The connection’s DNS mask.

    • Ntp (dict) –

      Network time protocol (NTP) server settings.

      • NtpServers (list) – [REQUIRED]

        NTP servers to use, in order of preference.

        • (string) –

  • Tags (dict) –

    Tags for the device.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Certificates': b'bytes',
    'DeviceId': 'string',
    'IotThingName': 'string',
    'Status': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The device’s ARN.

    • Certificates (bytes) –

      The device’s configuration bundle.

    • DeviceId (string) –

      The device’s ID.

    • IotThingName (string) –

      The device’s IoT thing name.

    • Status (string) –

      The device’s status.

Exceptions