Skip to content

DeviceManagementDeviceTypeOptionsRead22V6

Bases: OCIType

Device Management System device type options.

Note: For the elements listed below, when device configuration is set to deviceManagement, those elements apply to the creation of the Polycom Phone Services directory file only.
      For all other files, they are not used. Those elements are instead configured on a per-file basis at the Device Type File level.
      When device configuration is set to legacy, those elements apply to all configuration files except bearerFileAuthentication which is not supported.

      useHttpDigestAuthentication
      macBasedFileAuthentication
      userNamePasswordFileAuthentication
      macInNonRequestURI
      macInCert
      macFormatInNonRequestURI

The following data elements are only used in AS data mode:
      enableDeviceActivation, value ‘false’ is returned
      supportLinks, value ‘Not Supported’ is returned

The following elements are only used in AS data mode and not returned in XS data mode
      deviceModel
      autoLinkingDeviceType
      autoCreateDevicesLevel
      isActivationCodeThroughMessagingServer
      bearerFileAuthentication

Attributes:

device_access_protocol (str):

tag_mode (str):

tag_set (Optional[str]):

allow_device_profile_custom_tag_set (bool):

allow_group_custom_tag_set (bool):

allow_sp_custom_tag_set (bool):

send_email_upon_reset_failure (bool):

device_access_net_address (Optional[str]):

device_access_port (Optional[int]):

device_access_context (Optional[str]):

device_access_uri (Optional[str]):

default_device_language (Optional[str]):

default_device_encoding (Optional[str]):

access_device_credentials (Optional[str]):

use_http_digest_authentication (bool):

mac_based_file_authentication (bool):

user_name_password_file_authentication (bool):

mac_in_non_request_uri (bool):

mac_in_cert (bool):

mac_format_in_non_request_uri (Optional[str]):

enable_device_activation (bool):

device_model (Optional[str]):

support_links (str):

auto_linking_device_type (Optional[str]):

auto_create_devices_level (Optional[str]):

is_activation_code_through_messaging_server (Optional[bool]):

bearer_file_authentication (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class DeviceManagementDeviceTypeOptionsRead22V6(OCIType):
    """Device Management System device type options.

        Note: For the elements listed below, when device configuration is set to deviceManagement, those elements apply to the creation of the Polycom Phone Services directory file only.
              For all other files, they are not used. Those elements are instead configured on a per-file basis at the Device Type File level.
              When device configuration is set to legacy, those elements apply to all configuration files except bearerFileAuthentication which is not supported.

              useHttpDigestAuthentication
              macBasedFileAuthentication
              userNamePasswordFileAuthentication
              macInNonRequestURI
              macInCert
              macFormatInNonRequestURI

        The following data elements are only used in AS data mode:
              enableDeviceActivation, value ‘false’ is returned
              supportLinks, value ‘Not Supported’ is returned

        The following elements are only used in AS data mode and not returned in XS data mode
              deviceModel
              autoLinkingDeviceType
              autoCreateDevicesLevel
              isActivationCodeThroughMessagingServer
              bearerFileAuthentication

    Attributes:

        device_access_protocol (str):

        tag_mode (str):

        tag_set (Optional[str]):

        allow_device_profile_custom_tag_set (bool):

        allow_group_custom_tag_set (bool):

        allow_sp_custom_tag_set (bool):

        send_email_upon_reset_failure (bool):

        device_access_net_address (Optional[str]):

        device_access_port (Optional[int]):

        device_access_context (Optional[str]):

        device_access_uri (Optional[str]):

        default_device_language (Optional[str]):

        default_device_encoding (Optional[str]):

        access_device_credentials (Optional[str]):

        use_http_digest_authentication (bool):

        mac_based_file_authentication (bool):

        user_name_password_file_authentication (bool):

        mac_in_non_request_uri (bool):

        mac_in_cert (bool):

        mac_format_in_non_request_uri (Optional[str]):

        enable_device_activation (bool):

        device_model (Optional[str]):

        support_links (str):

        auto_linking_device_type (Optional[str]):

        auto_create_devices_level (Optional[str]):

        is_activation_code_through_messaging_server (Optional[bool]):

        bearer_file_authentication (bool):

    """

    device_access_protocol: str = field(metadata={"alias": "deviceAccessProtocol"})

    tag_mode: str = field(metadata={"alias": "tagMode"})

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

    allow_device_profile_custom_tag_set: bool = field(
        metadata={"alias": "allowDeviceProfileCustomTagSet"}
    )

    allow_group_custom_tag_set: bool = field(
        metadata={"alias": "allowGroupCustomTagSet"}
    )

    allow_sp_custom_tag_set: bool = field(metadata={"alias": "allowSpCustomTagSet"})

    send_email_upon_reset_failure: bool = field(
        metadata={"alias": "sendEmailUponResetFailure"}
    )

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

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

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

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

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

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

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

    use_http_digest_authentication: bool = field(
        metadata={"alias": "useHttpDigestAuthentication"}
    )

    mac_based_file_authentication: bool = field(
        metadata={"alias": "macBasedFileAuthentication"}
    )

    user_name_password_file_authentication: bool = field(
        metadata={"alias": "userNamePasswordFileAuthentication"}
    )

    mac_in_non_request_uri: bool = field(metadata={"alias": "macInNonRequestURI"})

    mac_in_cert: bool = field(metadata={"alias": "macInCert"})

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

    enable_device_activation: bool = field(metadata={"alias": "enableDeviceActivation"})

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

    support_links: str = field(metadata={"alias": "supportLinks"})

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

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

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

    bearer_file_authentication: bool = field(
        metadata={"alias": "bearerFileAuthentication"}
    )