GroupAccessDeviceAddRequest22V2

Bases: OCIRequest

Request to add a group access device. The response is either SuccessResponse or ErrorResponse.

The following elements are only used in AS data mode and ignored in XS data mode:
  groupExternalId
  deviceExternalId
  deviceIPEI

Attributes:

service_provider_id (Optional[str]):

group_id (Optional[str]):

device_name (Optional[str]):

group_external_id (Optional[str]):

device_external_id (Optional[str]):

device_type (str):

protocol (Optional[str]):

net_address (Optional[str]):

port (Optional[int]):

outbound_proxy_server_net_address (Optional[str]):

stun_server_net_address (Optional[str]):

mac_address (Optional[str]):

serial_number (Optional[str]):

description (Optional[str]):

physical_location (Optional[str]):

transport_protocol (Optional[str]):

use_custom_user_name_password (Optional[bool]):

access_device_credentials (Optional[DeviceManagementUserNamePassword16]):

device_ipei (Optional[str]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupAccessDeviceAddRequest22V2(OCIRequest):
    """Request to add a group access device.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are only used in AS data mode and ignored in XS data mode:
          groupExternalId
          deviceExternalId
          deviceIPEI

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        device_name (Optional[str]):

        group_external_id (Optional[str]):

        device_external_id (Optional[str]):

        device_type (str):

        protocol (Optional[str]):

        net_address (Optional[str]):

        port (Optional[int]):

        outbound_proxy_server_net_address (Optional[str]):

        stun_server_net_address (Optional[str]):

        mac_address (Optional[str]):

        serial_number (Optional[str]):

        description (Optional[str]):

        physical_location (Optional[str]):

        transport_protocol (Optional[str]):

        use_custom_user_name_password (Optional[bool]):

        access_device_credentials (Optional[DeviceManagementUserNamePassword16]):

        device_ipei (Optional[str]):

    """

    service_provider_id: Optional[str] = field(
        default=None, metadata={"alias": "serviceProviderId"}
    )

    group_id: Optional[str] = field(default=None, metadata={"alias": "groupId"})

    device_name: Optional[str] = field(default=None, metadata={"alias": "deviceName"})

    group_external_id: Optional[str] = field(
        default=None, metadata={"alias": "groupExternalId"}
    )

    device_external_id: Optional[str] = field(
        default=None, metadata={"alias": "deviceExternalId"}
    )

    device_type: str = field(metadata={"alias": "deviceType"})

    protocol: Optional[str] = field(default=None, metadata={"alias": "protocol"})

    net_address: Optional[str] = field(default=None, metadata={"alias": "netAddress"})

    port: Optional[int] = field(default=None, metadata={"alias": "port"})

    outbound_proxy_server_net_address: Optional[str] = field(
        default=None, metadata={"alias": "outboundProxyServerNetAddress"}
    )

    stun_server_net_address: Optional[str] = field(
        default=None, metadata={"alias": "stunServerNetAddress"}
    )

    mac_address: Optional[str] = field(default=None, metadata={"alias": "macAddress"})

    serial_number: Optional[str] = field(
        default=None, metadata={"alias": "serialNumber"}
    )

    description: Optional[str] = field(default=None, metadata={"alias": "description"})

    physical_location: Optional[str] = field(
        default=None, metadata={"alias": "physicalLocation"}
    )

    transport_protocol: Optional[str] = field(
        default=None, metadata={"alias": "transportProtocol"}
    )

    use_custom_user_name_password: Optional[bool] = field(
        default=None, metadata={"alias": "useCustomUserNamePassword"}
    )

    access_device_credentials: Optional[DeviceManagementUserNamePassword16] = field(
        default=None, metadata={"alias": "accessDeviceCredentials"}
    )

    device_ipei: Optional[str] = field(default=None, metadata={"alias": "deviceIPEI"})

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupAccessDeviceAddRequest22V2

client = Client()

command = GroupAccessDeviceAddRequest22V2(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    group_external_id=...,
    device_external_id=...,
    device_type=...,
    protocol=...,
    net_address=...,
    port=...,
    outbound_proxy_server_net_address=...,
    stun_server_net_address=...,
    mac_address=...,
    serial_number=...,
    description=...,
    physical_location=...,
    transport_protocol=...,
    use_custom_user_name_password=...,
    access_device_credentials=...,
    device_ipei=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceAddRequest22V2",
    service_provider_id=...,
    group_id=...,
    device_name=...,
    group_external_id=...,
    device_external_id=...,
    device_type=...,
    protocol=...,
    net_address=...,
    port=...,
    outbound_proxy_server_net_address=...,
    stun_server_net_address=...,
    mac_address=...,
    serial_number=...,
    description=...,
    physical_location=...,
    transport_protocol=...,
    use_custom_user_name_password=...,
    access_device_credentials=...,
    device_ipei=...,
)

print(response)