Skip to content

SystemCPEConfigParametersModifyRequest21

Bases: OCIRequest

Request to modify CPE Config system parameters. The response is either SuccessResponse or ErrorResponse.

The following elements are only used in the AS data mode and ignored in the XS data mode:
  allowDeviceCredentialsRetrieval

Attributes:

enable_ip_device_management (Optional[bool]):

ftp_connect_timeout_seconds (Optional[int]):

ftp_file_transfer_timeout_seconds (Optional[int]):

pause_between_file_rebuild_milliseconds (Optional[int]):

device_access_app_server_cluster_name (Optional[Nillable[str]]):

min_time_between_reset_milliseconds (Optional[int]):

always_push_files_on_rebuild (Optional[bool]):

max_file_operation_retry_attempts (Optional[int]):

enable_auto_rebuild_config (Optional[bool]):

event_queue_size (Optional[int]):

allow_device_credentials_retrieval (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemCPEConfigParametersModifyRequest21(OCIRequest):
    """Request to modify CPE Config system parameters.
        The response is either SuccessResponse or ErrorResponse.

        The following elements are only used in the AS data mode and ignored in the XS data mode:
          allowDeviceCredentialsRetrieval

    Attributes:

        enable_ip_device_management (Optional[bool]):

        ftp_connect_timeout_seconds (Optional[int]):

        ftp_file_transfer_timeout_seconds (Optional[int]):

        pause_between_file_rebuild_milliseconds (Optional[int]):

        device_access_app_server_cluster_name (Optional[Nillable[str]]):

        min_time_between_reset_milliseconds (Optional[int]):

        always_push_files_on_rebuild (Optional[bool]):

        max_file_operation_retry_attempts (Optional[int]):

        enable_auto_rebuild_config (Optional[bool]):

        event_queue_size (Optional[int]):

        allow_device_credentials_retrieval (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["device_access_app_server_cluster_name"]
        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/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 SystemCPEConfigParametersModifyRequest21

client = Client()

command = SystemCPEConfigParametersModifyRequest21(
    enable_ip_device_management=...,
    ftp_connect_timeout_seconds=...,
    ftp_file_transfer_timeout_seconds=...,
    pause_between_file_rebuild_milliseconds=...,
    device_access_app_server_cluster_name=...,
    min_time_between_reset_milliseconds=...,
    always_push_files_on_rebuild=...,
    max_file_operation_retry_attempts=...,
    enable_auto_rebuild_config=...,
    event_queue_size=...,
    allow_device_credentials_retrieval=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemCPEConfigParametersModifyRequest21",
    enable_ip_device_management=...,
    ftp_connect_timeout_seconds=...,
    ftp_file_transfer_timeout_seconds=...,
    pause_between_file_rebuild_milliseconds=...,
    device_access_app_server_cluster_name=...,
    min_time_between_reset_milliseconds=...,
    always_push_files_on_rebuild=...,
    max_file_operation_retry_attempts=...,
    enable_auto_rebuild_config=...,
    event_queue_size=...,
    allow_device_credentials_retrieval=...,
)

print(response)