CreateRoverNodeDetails

class oci.rover.models.CreateRoverNodeDetails(**kwargs)

Bases: object

The information required to create a RoverNode.

Attributes:

CERT_KEY_ALGORITHM_ECDSA_P256

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails.

CERT_KEY_ALGORITHM_ECDSA_P384

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails.

CERT_KEY_ALGORITHM_RSA2048

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails.

CERT_KEY_ALGORITHM_RSA4096

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA256_WITH_ECDSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA256_WITH_RSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA384_WITH_ECDSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA384_WITH_RSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA512_WITH_ECDSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

CERT_SIGNATURE_ALGORITHM_SHA512_WITH_RSA

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails.

ENCLOSURE_TYPE_NON_RUGGADIZED

A constant which can be used with the enclosure_type property of a CreateRoverNodeDetails.

ENCLOSURE_TYPE_RUGGADIZED

A constant which can be used with the enclosure_type property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails.

SHIPPING_PREFERENCE_CUSTOMER_PICKUP

A constant which can be used with the shipping_preference property of a CreateRoverNodeDetails.

SHIPPING_PREFERENCE_ORACLE_SHIPPED

A constant which can be used with the shipping_preference property of a CreateRoverNodeDetails.

cert_compartment_id

Gets the cert_compartment_id of this CreateRoverNodeDetails.

cert_key_algorithm

Gets the cert_key_algorithm of this CreateRoverNodeDetails.

cert_signature_algorithm

Gets the cert_signature_algorithm of this CreateRoverNodeDetails.

certificate_authority_id

Gets the certificate_authority_id of this CreateRoverNodeDetails.

common_name

Gets the common_name of this CreateRoverNodeDetails.

compartment_id

[Required] Gets the compartment_id of this CreateRoverNodeDetails.

customer_shipping_address

Gets the customer_shipping_address of this CreateRoverNodeDetails.

data_validation_code

Gets the data_validation_code of this CreateRoverNodeDetails.

defined_tags

Gets the defined_tags of this CreateRoverNodeDetails.

display_name

[Required] Gets the display_name of this CreateRoverNodeDetails.

enclosure_type

Gets the enclosure_type of this CreateRoverNodeDetails.

freeform_tags

Gets the freeform_tags of this CreateRoverNodeDetails.

import_compartment_id

Gets the import_compartment_id of this CreateRoverNodeDetails.

import_file_bucket

Gets the import_file_bucket of this CreateRoverNodeDetails.

is_import_requested

Gets the is_import_requested of this CreateRoverNodeDetails.

lifecycle_state

Gets the lifecycle_state of this CreateRoverNodeDetails.

lifecycle_state_details

Gets the lifecycle_state_details of this CreateRoverNodeDetails.

master_key_id

Gets the master_key_id of this CreateRoverNodeDetails.

node_workloads

Gets the node_workloads of this CreateRoverNodeDetails.

oracle_shipping_tracking_url

Gets the oracle_shipping_tracking_url of this CreateRoverNodeDetails.

point_of_contact

Gets the point_of_contact of this CreateRoverNodeDetails.

point_of_contact_phone_number

Gets the point_of_contact_phone_number of this CreateRoverNodeDetails.

public_key

Gets the public_key of this CreateRoverNodeDetails.

serial_number

Gets the serial_number of this CreateRoverNodeDetails.

shape

Gets the shape of this CreateRoverNodeDetails.

shipping_preference

Gets the shipping_preference of this CreateRoverNodeDetails.

shipping_vendor

Gets the shipping_vendor of this CreateRoverNodeDetails.

super_user_password

Gets the super_user_password of this CreateRoverNodeDetails.

system_tags

Gets the system_tags of this CreateRoverNodeDetails.

time_cert_validity_end

Gets the time_cert_validity_end of this CreateRoverNodeDetails.

time_pickup_expected

Gets the time_pickup_expected of this CreateRoverNodeDetails.

time_return_window_ends

Gets the time_return_window_ends of this CreateRoverNodeDetails.

time_return_window_starts

Gets the time_return_window_starts of this CreateRoverNodeDetails.

unlock_passphrase

Gets the unlock_passphrase of this CreateRoverNodeDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateRoverNodeDetails object with values from keyword arguments.

CERT_KEY_ALGORITHM_ECDSA_P256 = 'ECDSA_P256'

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails. This constant has a value of “ECDSA_P256”

CERT_KEY_ALGORITHM_ECDSA_P384 = 'ECDSA_P384'

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails. This constant has a value of “ECDSA_P384”

CERT_KEY_ALGORITHM_RSA2048 = 'RSA2048'

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails. This constant has a value of “RSA2048”

CERT_KEY_ALGORITHM_RSA4096 = 'RSA4096'

A constant which can be used with the cert_key_algorithm property of a CreateRoverNodeDetails. This constant has a value of “RSA4096”

CERT_SIGNATURE_ALGORITHM_SHA256_WITH_ECDSA = 'SHA256_WITH_ECDSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA256_WITH_ECDSA”

CERT_SIGNATURE_ALGORITHM_SHA256_WITH_RSA = 'SHA256_WITH_RSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA256_WITH_RSA”

CERT_SIGNATURE_ALGORITHM_SHA384_WITH_ECDSA = 'SHA384_WITH_ECDSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA384_WITH_ECDSA”

CERT_SIGNATURE_ALGORITHM_SHA384_WITH_RSA = 'SHA384_WITH_RSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA384_WITH_RSA”

CERT_SIGNATURE_ALGORITHM_SHA512_WITH_ECDSA = 'SHA512_WITH_ECDSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA512_WITH_ECDSA”

CERT_SIGNATURE_ALGORITHM_SHA512_WITH_RSA = 'SHA512_WITH_RSA'

A constant which can be used with the cert_signature_algorithm property of a CreateRoverNodeDetails. This constant has a value of “SHA512_WITH_RSA”

ENCLOSURE_TYPE_NON_RUGGADIZED = 'NON_RUGGADIZED'

A constant which can be used with the enclosure_type property of a CreateRoverNodeDetails. This constant has a value of “NON_RUGGADIZED”

ENCLOSURE_TYPE_RUGGADIZED = 'RUGGADIZED'

A constant which can be used with the enclosure_type property of a CreateRoverNodeDetails. This constant has a value of “RUGGADIZED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a CreateRoverNodeDetails. This constant has a value of “UPDATING”

SHIPPING_PREFERENCE_CUSTOMER_PICKUP = 'CUSTOMER_PICKUP'

A constant which can be used with the shipping_preference property of a CreateRoverNodeDetails. This constant has a value of “CUSTOMER_PICKUP”

SHIPPING_PREFERENCE_ORACLE_SHIPPED = 'ORACLE_SHIPPED'

A constant which can be used with the shipping_preference property of a CreateRoverNodeDetails. This constant has a value of “ORACLE_SHIPPED”

__init__(**kwargs)

Initializes a new CreateRoverNodeDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateRoverNodeDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateRoverNodeDetails.

  • shape (str) – The value to assign to the shape property of this CreateRoverNodeDetails.

  • customer_shipping_address (oci.rover.models.ShippingAddress) – The value to assign to the customer_shipping_address property of this CreateRoverNodeDetails.

  • node_workloads (list[oci.rover.models.RoverWorkload]) – The value to assign to the node_workloads property of this CreateRoverNodeDetails.

  • super_user_password (str) – The value to assign to the super_user_password property of this CreateRoverNodeDetails.

  • unlock_passphrase (str) – The value to assign to the unlock_passphrase property of this CreateRoverNodeDetails.

  • point_of_contact (str) – The value to assign to the point_of_contact property of this CreateRoverNodeDetails.

  • point_of_contact_phone_number (str) – The value to assign to the point_of_contact_phone_number property of this CreateRoverNodeDetails.

  • shipping_preference (str) – The value to assign to the shipping_preference property of this CreateRoverNodeDetails. Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”

  • shipping_vendor (str) – The value to assign to the shipping_vendor property of this CreateRoverNodeDetails.

  • time_pickup_expected (datetime) – The value to assign to the time_pickup_expected property of this CreateRoverNodeDetails.

  • public_key (str) – The value to assign to the public_key property of this CreateRoverNodeDetails.

  • time_return_window_starts (datetime) – The value to assign to the time_return_window_starts property of this CreateRoverNodeDetails.

  • time_return_window_ends (datetime) – The value to assign to the time_return_window_ends property of this CreateRoverNodeDetails.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateRoverNodeDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • enclosure_type (str) – The value to assign to the enclosure_type property of this CreateRoverNodeDetails. Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”

  • lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this CreateRoverNodeDetails.

  • serial_number (str) – The value to assign to the serial_number property of this CreateRoverNodeDetails.

  • oracle_shipping_tracking_url (str) – The value to assign to the oracle_shipping_tracking_url property of this CreateRoverNodeDetails.

  • is_import_requested (bool) – The value to assign to the is_import_requested property of this CreateRoverNodeDetails.

  • import_compartment_id (str) – The value to assign to the import_compartment_id property of this CreateRoverNodeDetails.

  • import_file_bucket (str) – The value to assign to the import_file_bucket property of this CreateRoverNodeDetails.

  • data_validation_code (str) – The value to assign to the data_validation_code property of this CreateRoverNodeDetails.

  • master_key_id (str) – The value to assign to the master_key_id property of this CreateRoverNodeDetails.

  • certificate_authority_id (str) – The value to assign to the certificate_authority_id property of this CreateRoverNodeDetails.

  • time_cert_validity_end (datetime) – The value to assign to the time_cert_validity_end property of this CreateRoverNodeDetails.

  • common_name (str) – The value to assign to the common_name property of this CreateRoverNodeDetails.

  • cert_compartment_id (str) – The value to assign to the cert_compartment_id property of this CreateRoverNodeDetails.

  • cert_key_algorithm (str) – The value to assign to the cert_key_algorithm property of this CreateRoverNodeDetails. Allowed values for this property are: “RSA2048”, “RSA4096”, “ECDSA_P256”, “ECDSA_P384”

  • cert_signature_algorithm (str) – The value to assign to the cert_signature_algorithm property of this CreateRoverNodeDetails. Allowed values for this property are: “SHA256_WITH_RSA”, “SHA384_WITH_RSA”, “SHA512_WITH_RSA”, “SHA256_WITH_ECDSA”, “SHA384_WITH_ECDSA”, “SHA512_WITH_ECDSA”

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRoverNodeDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRoverNodeDetails.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CreateRoverNodeDetails.

property cert_compartment_id

Gets the cert_compartment_id of this CreateRoverNodeDetails. The compartmentId of the leaf certificate.

Returns

The cert_compartment_id of this CreateRoverNodeDetails.

Return type

str

property cert_key_algorithm

Gets the cert_key_algorithm of this CreateRoverNodeDetails. key algorithm for issuing leaf certificate.

Allowed values for this property are: “RSA2048”, “RSA4096”, “ECDSA_P256”, “ECDSA_P384”

Returns

The cert_key_algorithm of this CreateRoverNodeDetails.

Return type

str

property cert_signature_algorithm

Gets the cert_signature_algorithm of this CreateRoverNodeDetails. signature algorithm for issuing leaf certificate.

Allowed values for this property are: “SHA256_WITH_RSA”, “SHA384_WITH_RSA”, “SHA512_WITH_RSA”, “SHA256_WITH_ECDSA”, “SHA384_WITH_ECDSA”, “SHA512_WITH_ECDSA”

Returns

The cert_signature_algorithm of this CreateRoverNodeDetails.

Return type

str

property certificate_authority_id

Gets the certificate_authority_id of this CreateRoverNodeDetails. The certificateAuthorityId of subordinate/intermediate certificate authority.

Returns

The certificate_authority_id of this CreateRoverNodeDetails.

Return type

str

property common_name

Gets the common_name of this CreateRoverNodeDetails. The common name for the leaf certificate.

Returns

The common_name of this CreateRoverNodeDetails.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CreateRoverNodeDetails. The OCID of the compartment containing the RoverNode.

Returns

The compartment_id of this CreateRoverNodeDetails.

Return type

str

property customer_shipping_address

Gets the customer_shipping_address of this CreateRoverNodeDetails.

Returns

The customer_shipping_address of this CreateRoverNodeDetails.

Return type

oci.rover.models.ShippingAddress

property data_validation_code

Gets the data_validation_code of this CreateRoverNodeDetails. Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.

Returns

The data_validation_code of this CreateRoverNodeDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateRoverNodeDetails. The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateRoverNodeDetails.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this CreateRoverNodeDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this CreateRoverNodeDetails.

Return type

str

property enclosure_type

Gets the enclosure_type of this CreateRoverNodeDetails. The type of enclosure rover nodes in this cluster are shipped in.

Allowed values for this property are: “RUGGADIZED”, “NON_RUGGADIZED”

Returns

The enclosure_type of this CreateRoverNodeDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateRoverNodeDetails. The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateRoverNodeDetails.

Return type

dict(str, str)

property import_compartment_id

Gets the import_compartment_id of this CreateRoverNodeDetails. An OCID of a compartment where data will be imported to upon Rover node return.

Returns

The import_compartment_id of this CreateRoverNodeDetails.

Return type

str

property import_file_bucket

Gets the import_file_bucket of this CreateRoverNodeDetails. Name of a bucket where files from NFS share will be imported to upon Rover node return.

Returns

The import_file_bucket of this CreateRoverNodeDetails.

Return type

str

property is_import_requested

Gets the is_import_requested of this CreateRoverNodeDetails. The flag indicating that customer requests data to be imported to OCI upon Rover node return.

Returns

The is_import_requested of this CreateRoverNodeDetails.

Return type

bool

property lifecycle_state

Gets the lifecycle_state of this CreateRoverNodeDetails. The current state of the RoverNode.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

Returns

The lifecycle_state of this CreateRoverNodeDetails.

Return type

str

property lifecycle_state_details

Gets the lifecycle_state_details of this CreateRoverNodeDetails. A property that can contain details on the lifecycle.

Returns

The lifecycle_state_details of this CreateRoverNodeDetails.

Return type

str

property master_key_id

Gets the master_key_id of this CreateRoverNodeDetails. Customer provided master key ID to encrypt secret information. If not provided, Rover’s master key will be used for encryption.

Returns

The master_key_id of this CreateRoverNodeDetails.

Return type

str

property node_workloads

Gets the node_workloads of this CreateRoverNodeDetails. List of existing workloads that should be provisioned on the node.

Returns

The node_workloads of this CreateRoverNodeDetails.

Return type

list[oci.rover.models.RoverWorkload]

property oracle_shipping_tracking_url

Gets the oracle_shipping_tracking_url of this CreateRoverNodeDetails. Tracking Url for the shipped FmsRoverNode.

Returns

The oracle_shipping_tracking_url of this CreateRoverNodeDetails.

Return type

str

property point_of_contact

Gets the point_of_contact of this CreateRoverNodeDetails. Name of point of contact for this order if customer is picking up.

Returns

The point_of_contact of this CreateRoverNodeDetails.

Return type

str

property point_of_contact_phone_number

Gets the point_of_contact_phone_number of this CreateRoverNodeDetails. Phone number of point of contact for this order if customer is picking up.

Returns

The point_of_contact_phone_number of this CreateRoverNodeDetails.

Return type

str

property public_key

Gets the public_key of this CreateRoverNodeDetails. The public key of the resource principal

Returns

The public_key of this CreateRoverNodeDetails.

Return type

str

property serial_number

Gets the serial_number of this CreateRoverNodeDetails. Serial number of the node.

Returns

The serial_number of this CreateRoverNodeDetails.

Return type

str

property shape

Gets the shape of this CreateRoverNodeDetails. The shape of the node.

Returns

The shape of this CreateRoverNodeDetails.

Return type

str

property shipping_preference

Gets the shipping_preference of this CreateRoverNodeDetails. Preference for device delivery.

Allowed values for this property are: “ORACLE_SHIPPED”, “CUSTOMER_PICKUP”

Returns

The shipping_preference of this CreateRoverNodeDetails.

Return type

str

property shipping_vendor

Gets the shipping_vendor of this CreateRoverNodeDetails. Shipping vendor of choice for orace to customer shipping.

Returns

The shipping_vendor of this CreateRoverNodeDetails.

Return type

str

property super_user_password

Gets the super_user_password of this CreateRoverNodeDetails. Root password for the rover node.

Returns

The super_user_password of this CreateRoverNodeDetails.

Return type

str

property system_tags

Gets the system_tags of this CreateRoverNodeDetails. The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns

The system_tags of this CreateRoverNodeDetails.

Return type

dict(str, dict(str, object))

property time_cert_validity_end

Gets the time_cert_validity_end of this CreateRoverNodeDetails. The time after which leaf certificate will invalid.

Returns

The time_cert_validity_end of this CreateRoverNodeDetails.

Return type

datetime

property time_pickup_expected

Gets the time_pickup_expected of this CreateRoverNodeDetails. Expected date when customer wants to pickup the device if they chose customer pickup.

Returns

The time_pickup_expected of this CreateRoverNodeDetails.

Return type

datetime

property time_return_window_ends

Gets the time_return_window_ends of this CreateRoverNodeDetails. End time for the window to pickup the device from customer.

Returns

The time_return_window_ends of this CreateRoverNodeDetails.

Return type

datetime

property time_return_window_starts

Gets the time_return_window_starts of this CreateRoverNodeDetails. Start time for the window to pickup the device from customer.

Returns

The time_return_window_starts of this CreateRoverNodeDetails.

Return type

datetime

property unlock_passphrase

Gets the unlock_passphrase of this CreateRoverNodeDetails. Passphrase to unlock the rover node.

Returns

The unlock_passphrase of this CreateRoverNodeDetails.

Return type

str