Skip to content

ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22

Bases: OCIType

Access device end point used in the context of add. The endpoint is identified by its linePort (public Identity) and possibly a private Identity. In XS data mode, only one contact can be defined. Only Static Registration capable devices may have more than one contact defined. Port numbers are only used by devices with static line ordering.

In the case an access device referenced by accessDevice does not exist, the device will be added.

The device attributes deviceType, protocol, netAddress, port, outboundProxyServerNetAddress,
stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, transportProtocol,
useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access device already
exists.

The following elements are only used in AS data mode and ignored in XS data mode:
  useHotline, use value false in XS data mode
  hotlineContact

Attributes:

access_device (AccessDevice):

line_port (str):

private_identity (Optional[str]):

contact (Optional[List[str]]):

port_number (Optional[int]):

device_type (Optional[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]):

use_hotline (bool):

hotline_contact (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ConsolidatedAccessDeviceMultipleIdentityEndpointAndContactAdd22(OCIType):
    """Access device end point used in the context of add.
        The endpoint is identified by its linePort (public Identity) and possibly a private Identity.
        In XS data mode, only one contact can be defined.
        Only Static Registration capable devices may have more than one contact defined.
        Port numbers are only used by devices with static line ordering.

        In the case an access device referenced by accessDevice does not exist, the device will be added.

        The device attributes deviceType, protocol, netAddress, port, outboundProxyServerNetAddress,
        stunServerNetAddress, macAddress, serialNumber, description, physicalLocation, transportProtocol,
        useCustomUserNamePassword and accessDeviceCredentials will be ignored if the access device already
        exists.

        The following elements are only used in AS data mode and ignored in XS data mode:
          useHotline, use value false in XS data mode
          hotlineContact

    Attributes:

        access_device (AccessDevice):

        line_port (str):

        private_identity (Optional[str]):

        contact (Optional[List[str]]):

        port_number (Optional[int]):

        device_type (Optional[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]):

        use_hotline (bool):

        hotline_contact (Optional[str]):

    """

    access_device: AccessDevice = field(metadata={"alias": "accessDevice"})

    line_port: str = field(metadata={"alias": "linePort"})

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

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

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

    device_type: Optional[str] = field(default=None, 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"}
    )

    use_hotline: bool = field(metadata={"alias": "useHotline"})

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