Skip to content

SystemSIPDeviceTypeFileModifyRequest16sp1

Bases: OCIRequest

Request to modify a sip device type file. The response is either SuccessResponse or ErrorResponse.

  The following logic applies to these elements:
    macInCert
    macInNonRequestURI
    The two elements are mutually exclusive.
    When both are set to true, the command fails.
    When macInCert is set to true, macInNonRequestURI will be reset to false.
    When macInNonRequestURI is set to true, macInCert will be reset to false.

  The following elements are ignored in XS data mode:
    bearerFileAuthentication

Attributes:

device_type (str):

file_format (str):

file_customization (Optional[str]):

file_source (Optional[str]):

upload_file (Optional[FileResource]):

use_http_digest_authentication (Optional[bool]):

mac_based_file_authentication (Optional[bool]):

user_name_password_file_authentication (Optional[bool]):

mac_in_non_request_uri (Optional[bool]):

mac_in_cert (Optional[bool]):

mac_format_in_non_request_uri (Optional[Nillable[str]]):

allow_http (Optional[bool]):

allow_https (Optional[bool]):

allow_tftp (Optional[bool]):

enable_caching (Optional[bool]):

allow_upload_from_device (Optional[bool]):

default_extended_file_capture_mode (Optional[bool]):

bearer_file_authentication (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemSIPDeviceTypeFileModifyRequest16sp1(OCIRequest):
    """Request to modify a sip device type file.
          The response is either SuccessResponse or ErrorResponse.

          The following logic applies to these elements:
            macInCert
            macInNonRequestURI
            The two elements are mutually exclusive.
            When both are set to true, the command fails.
            When macInCert is set to true, macInNonRequestURI will be reset to false.
            When macInNonRequestURI is set to true, macInCert will be reset to false.

          The following elements are ignored in XS data mode:
            bearerFileAuthentication

    Attributes:

        device_type (str):

        file_format (str):

        file_customization (Optional[str]):

        file_source (Optional[str]):

        upload_file (Optional[FileResource]):

        use_http_digest_authentication (Optional[bool]):

        mac_based_file_authentication (Optional[bool]):

        user_name_password_file_authentication (Optional[bool]):

        mac_in_non_request_uri (Optional[bool]):

        mac_in_cert (Optional[bool]):

        mac_format_in_non_request_uri (Optional[Nillable[str]]):

        allow_http (Optional[bool]):

        allow_https (Optional[bool]):

        allow_tftp (Optional[bool]):

        enable_caching (Optional[bool]):

        allow_upload_from_device (Optional[bool]):

        default_extended_file_capture_mode (Optional[bool]):

        bearer_file_authentication (Optional[bool]):

    """

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

    file_format: str = field(metadata={"alias": "fileFormat"})

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

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

    upload_file: Optional[FileResource] = field(
        default=None, metadata={"alias": "uploadFile"}
    )

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

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

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["mac_format_in_non_request_uri"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import SystemSIPDeviceTypeFileModifyRequest16sp1

client = Client()

command = SystemSIPDeviceTypeFileModifyRequest16sp1(
    device_type=...,
    file_format=...,
    file_customization=...,
    file_source=...,
    upload_file=...,
    use_http_digest_authentication=...,
    mac_based_file_authentication=...,
    user_name_password_file_authentication=...,
    mac_in_non_request_uri=...,
    mac_in_cert=...,
    mac_format_in_non_request_uri=...,
    allow_http=...,
    allow_https=...,
    allow_tftp=...,
    enable_caching=...,
    allow_upload_from_device=...,
    default_extended_file_capture_mode=...,
    bearer_file_authentication=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemSIPDeviceTypeFileModifyRequest16sp1",
    device_type=...,
    file_format=...,
    file_customization=...,
    file_source=...,
    upload_file=...,
    use_http_digest_authentication=...,
    mac_based_file_authentication=...,
    user_name_password_file_authentication=...,
    mac_in_non_request_uri=...,
    mac_in_cert=...,
    mac_format_in_non_request_uri=...,
    allow_http=...,
    allow_https=...,
    allow_tftp=...,
    enable_caching=...,
    allow_upload_from_device=...,
    default_extended_file_capture_mode=...,
    bearer_file_authentication=...,
)

print(response)