Skip to content

SystemCPEConfigParametersGetRequest21

Bases: OCIRequest

Request to get the list of CPE Config system parameters. The response is either SystemCPEConfigParametersGetResponse21 or ErrorResponse.

Attributes:

Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemCPEConfigParametersGetRequest21(OCIRequest):
    """Request to get the list of CPE Config system parameters.
        The response is either SystemCPEConfigParametersGetResponse21 or ErrorResponse.

    Attributes:

    """

Responses

Bases: OCIDataResponse

Response to SystemCPEConfigParametersGetRequest21. Contains a list of system CPE Config parameters.

The following elements are only used in AS data mode:
  allowDeviceCredentialsRetrieval, value "false" is returned in XS data mode

Attributes:

enable_ip_device_management (bool):

ftp_connect_timeout_seconds (int):

ftp_file_transfer_timeout_seconds (int):

pause_between_file_rebuild_milliseconds (int):

device_access_app_server_cluster_name (Optional[str]):

min_time_between_reset_milliseconds (int):

always_push_files_on_rebuild (bool):

max_file_operation_retry_attempts (int):

enable_auto_rebuild_config (bool):

event_queue_size (int):

allow_device_credentials_retrieval (bool):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemCPEConfigParametersGetResponse21(OCIDataResponse):
    """Response to SystemCPEConfigParametersGetRequest21.
        Contains a list of system CPE Config parameters.

        The following elements are only used in AS data mode:
          allowDeviceCredentialsRetrieval, value \"false\" is returned in XS data mode

    Attributes:

        enable_ip_device_management (bool):

        ftp_connect_timeout_seconds (int):

        ftp_file_transfer_timeout_seconds (int):

        pause_between_file_rebuild_milliseconds (int):

        device_access_app_server_cluster_name (Optional[str]):

        min_time_between_reset_milliseconds (int):

        always_push_files_on_rebuild (bool):

        max_file_operation_retry_attempts (int):

        enable_auto_rebuild_config (bool):

        event_queue_size (int):

        allow_device_credentials_retrieval (bool):

    """

    enable_ip_device_management: bool = field(
        metadata={"alias": "enableIPDeviceManagement"}
    )

    ftp_connect_timeout_seconds: int = field(
        metadata={"alias": "ftpConnectTimeoutSeconds"}
    )

    ftp_file_transfer_timeout_seconds: int = field(
        metadata={"alias": "ftpFileTransferTimeoutSeconds"}
    )

    pause_between_file_rebuild_milliseconds: int = field(
        metadata={"alias": "pauseBetweenFileRebuildMilliseconds"}
    )

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

    min_time_between_reset_milliseconds: int = field(
        metadata={"alias": "minTimeBetweenResetMilliseconds"}
    )

    always_push_files_on_rebuild: bool = field(
        metadata={"alias": "alwaysPushFilesOnRebuild"}
    )

    max_file_operation_retry_attempts: int = field(
        metadata={"alias": "maxFileOperationRetryAttempts"}
    )

    enable_auto_rebuild_config: bool = field(
        metadata={"alias": "enableAutoRebuildConfig"}
    )

    event_queue_size: int = field(metadata={"alias": "eventQueueSize"})

    allow_device_credentials_retrieval: bool = field(
        metadata={"alias": "allowDeviceCredentialsRetrieval"}
    )

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 SystemCPEConfigParametersGetRequest21

client = Client()

command = SystemCPEConfigParametersGetRequest21()

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemCPEConfigParametersGetRequest21")

print(response)