oracle.oci.oci_rover_cluster – Manage a RoverCluster resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_rover_cluster.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a RoverCluster resource in Oracle Cloud Infrastructure
For state=present, creates a new RoverCluster.
This resource has the following action operations in the oracle.oci.oci_rover_cluster_actions module: change_compartment.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
api_user string			The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string			Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string			Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string			Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_purpose string		Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string		Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle string			The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
cluster_size integer			Number of nodes desired in the cluster, in standalone clusters, between 5 and 15 inclusive. In station clusters, between 15 and 30 inclusive. Required for create using state=present. This parameter is updatable.
cluster_type string		Choices: STANDALONE STATION	Type of cluster.
cluster_workloads list / elements=dictionary			List of existing workloads that should be provisioned on the nodes. This parameter is updatable.
	compartment_id string / required		The OCID of the compartment containing the workload.
	id string / required		The Unique Oracle ID (OCID) that is immutable on creation.
	name string		Name of the Rover Workload
	object_count string		Number of objects in a workload.
	prefix string		Prefix to filter objects in case it is a bucket.
	range_end string		End of the range in a bucket.
	range_start string		Start of the range in a bucket.
	size string		Size of the workload.
	work_request_id string		The compute work request id to track progress of custom image exports.
	workload_type string / required		The type of workload
compartment_id string			The OCID of the compartment containing the RoverCluster. Required for create using state=present. Required for update when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. Required for delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set.
config_file_location string			Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string			The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
customer_shipping_address dictionary			This parameter is updatable.
	address1 string / required		Address line 1.
	address2 string		Address line 2.
	address3 string		Address line 3.
	address4 string		Address line 4.
	addressee string / required		Addressee in shipping address.
	care_of string		CareOf for shipping address.
	city_or_locality string / required		city or locality for shipping address.
	country string / required		country for shipping address.
	email string		recepient email address.
	phone_number string / required		recepient phone number.
	state_or_region string / required		state or region for shipping address.
	zipcode string / required		zipcode for shipping address.
data_validation_code string			Validation code returned by data validation tool. Required for return shipping label generation if data import was requested. This parameter is updatable.
defined_tags dictionary			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"}}` This parameter is updatable.
display_name string			A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Required for create using state=present. Required for update, delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. This parameter is updatable when `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: name
enclosure_type string		Choices: RUGGADIZED NON_RUGGADIZED	The type of enclosure rover nodes in this cluster are shipped in. This parameter is updatable.
force_create boolean		Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags dictionary			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"}` This parameter is updatable.
import_compartment_id string			An OCID of a compartment where data will be imported to upon Rover cluster return. This parameter is updatable.
import_file_bucket string			Name of a bucket where files from NFS share will be imported to upon Rover cluster return. This parameter is updatable.
is_import_requested boolean		Choices: no yes	The flag indicating that customer requests data to be imported to OCI upon Rover cluster return. This parameter is updatable.
key_by list / elements=string			The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
lifecycle_state string		Choices: CREATING UPDATING ACTIVE DELETING DELETED FAILED	The current state of the RoverCluster. This parameter is updatable.
lifecycle_state_details string			A property that can contain details on the lifecycle. This parameter is updatable.
master_key_id string			Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption.
oracle_shipping_tracking_url string			Tracking Url for the shipped Rover Cluster. This parameter is updatable.
point_of_contact string			Name of point of contact for this order if customer is picking up. This parameter is updatable.
point_of_contact_phone_number string			Phone number of point of contact for this order if customer is picking up. This parameter is updatable.
realm_specific_endpoint_template_enabled boolean		Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region string			The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
rover_cluster_id string			Unique RoverCluster identifier Required for update using state=present when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. Required for delete using state=absent when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: id
shipping_preference string		Choices: ORACLE_SHIPPED CUSTOMER_PICKUP	Preference for device delivery. This parameter is updatable.
shipping_vendor string			Shipping vendor of choice for orace to customer shipping. This parameter is updatable.
state string		Choices: present ← absent	The state of the RoverCluster. Use state=present to create or update a RoverCluster. Use state=absent to delete a RoverCluster.
subscription_id string			ID provided to customer after successful subscription to Rover Stations. This parameter is updatable.
super_user_password string			Root password for the rover cluster. This parameter is updatable.
system_tags dictionary			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}}` This parameter is updatable.
tenancy string			OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
time_pickup_expected string			Expected date when customer wants to pickup the cluster if they chose customer pickup. This parameter is updatable.
unlock_passphrase string			Password to unlock the rover cluster. This parameter is updatable.
wait boolean		Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer			Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create rover_cluster
  oci_rover_cluster:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    cluster_size: 56

    # optional
    cluster_type: STANDALONE
    master_key_id: "ocid1.masterkey.oc1..xxxxxxEXAMPLExxxxxx"
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example
      phone_number: phone_number_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      email: email_example
    cluster_workloads:
    - # required
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      workload_type: workload_type_example

      # optional
      name: name_example
      size: size_example
      object_count: object_count_example
      prefix: prefix_example
      range_start: range_start_example
      range_end: range_end_example
      work_request_id: "ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx"
    super_user_password: example-password
    lifecycle_state: CREATING
    lifecycle_state_details: lifecycle_state_details_example
    unlock_passphrase: unlock_passphrase_example
    enclosure_type: RUGGADIZED
    point_of_contact: point_of_contact_example
    point_of_contact_phone_number: point_of_contact_phone_number_example
    shipping_preference: ORACLE_SHIPPED
    oracle_shipping_tracking_url: oracle_shipping_tracking_url_example
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"
    shipping_vendor: shipping_vendor_example
    time_pickup_expected: time_pickup_expected_example
    is_import_requested: true
    import_compartment_id: "ocid1.importcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    import_file_bucket: import_file_bucket_example
    data_validation_code: data_validation_code_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null

- name: Update rover_cluster
  oci_rover_cluster:
    # required
    rover_cluster_id: "ocid1.rovercluster.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    cluster_size: 56
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example
      phone_number: phone_number_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      email: email_example
    cluster_workloads:
    - # required
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      workload_type: workload_type_example

      # optional
      name: name_example
      size: size_example
      object_count: object_count_example
      prefix: prefix_example
      range_start: range_start_example
      range_end: range_end_example
      work_request_id: "ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx"
    super_user_password: example-password
    lifecycle_state: CREATING
    lifecycle_state_details: lifecycle_state_details_example
    unlock_passphrase: unlock_passphrase_example
    enclosure_type: RUGGADIZED
    point_of_contact: point_of_contact_example
    point_of_contact_phone_number: point_of_contact_phone_number_example
    shipping_preference: ORACLE_SHIPPED
    oracle_shipping_tracking_url: oracle_shipping_tracking_url_example
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"
    shipping_vendor: shipping_vendor_example
    time_pickup_expected: time_pickup_expected_example
    is_import_requested: true
    import_compartment_id: "ocid1.importcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    import_file_bucket: import_file_bucket_example
    data_validation_code: data_validation_code_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null

- name: Update rover_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_rover_cluster:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    cluster_size: 56
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example
      phone_number: phone_number_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      email: email_example
    cluster_workloads:
    - # required
      compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      workload_type: workload_type_example

      # optional
      name: name_example
      size: size_example
      object_count: object_count_example
      prefix: prefix_example
      range_start: range_start_example
      range_end: range_end_example
      work_request_id: "ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx"
    super_user_password: example-password
    lifecycle_state: CREATING
    lifecycle_state_details: lifecycle_state_details_example
    unlock_passphrase: unlock_passphrase_example
    enclosure_type: RUGGADIZED
    point_of_contact: point_of_contact_example
    point_of_contact_phone_number: point_of_contact_phone_number_example
    shipping_preference: ORACLE_SHIPPED
    oracle_shipping_tracking_url: oracle_shipping_tracking_url_example
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"
    shipping_vendor: shipping_vendor_example
    time_pickup_expected: time_pickup_expected_example
    is_import_requested: true
    import_compartment_id: "ocid1.importcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    import_file_bucket: import_file_bucket_example
    data_validation_code: data_validation_code_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null

- name: Delete rover_cluster
  oci_rover_cluster:
    # required
    rover_cluster_id: "ocid1.rovercluster.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete rover_cluster using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_rover_cluster:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
rover_cluster complex			on success	Details of the RoverCluster resource acted upon by the current operation Sample: {'cluster_size': 56, 'cluster_type': 'STANDALONE', 'cluster_workloads': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'object_count': 'object_count_example', 'prefix': 'prefix_example', 'range_end': 'range_end_example', 'range_start': 'range_start_example', 'size': 'size_example', 'work_request_id': 'ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx', 'workload_type': 'workload_type_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'customer_shipping_address': {'address1': 'address1_example', 'address2': 'address2_example', 'address3': 'address3_example', 'address4': 'address4_example', 'addressee': 'addressee_example', 'care_of': 'care_of_example', 'city_or_locality': 'city_or_locality_example', 'country': 'country_example', 'email': 'email_example', 'phone_number': 'phone_number_example', 'state_or_region': 'us-phoenix-1', 'zipcode': 'zipcode_example'}, 'data_validation_code': 'data_validation_code_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'delivery_tracking_info': 'delivery_tracking_info_example', 'display_name': 'display_name_example', 'enclosure_type': 'RUGGADIZED', 'exterior_door_code': 'exterior_door_code_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_export_par': 'image_export_par_example', 'import_compartment_id': 'ocid1.importcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'import_file_bucket': 'import_file_bucket_example', 'interior_alarm_disarm_code': 'interior_alarm_disarm_code_example', 'is_import_requested': True, 'lifecycle_state': 'CREATING', 'lifecycle_state_details': 'lifecycle_state_details_example', 'master_key_id': 'ocid1.masterkey.oc1..xxxxxxEXAMPLExxxxxx', 'nodes': [{'cluster_id': 'ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'lifecycle_state_details': 'lifecycle_state_details_example', 'node_type': 'STANDALONE', 'serial_number': 'serial_number_example', 'shape': 'shape_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00'}], 'oracle_shipping_tracking_url': 'oracle_shipping_tracking_url_example', 'point_of_contact': 'point_of_contact_example', 'point_of_contact_phone_number': 'point_of_contact_phone_number_example', 'return_shipping_label_uri': 'return_shipping_label_uri_example', 'shipping_preference': 'ORACLE_SHIPPED', 'shipping_vendor': 'shipping_vendor_example', 'subscription_id': 'ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx', 'super_user_password': 'example-password', 'system_tags': {}, 'tags': 'tags_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_customer_received': '2013-10-20T19:20:30+01:00', 'time_customer_returned': '2013-10-20T19:20:30+01:00', 'time_pickup_expected': '2013-10-20T19:20:30+01:00', 'time_return_window_ends': '2013-10-20T19:20:30+01:00', 'time_return_window_starts': '2013-10-20T19:20:30+01:00', 'unlock_passphrase': 'unlock_passphrase_example'}
	cluster_size integer		on success	Size of the cluster. Sample: 56
	cluster_type string		on success	Type of cluster. Sample: STANDALONE
	cluster_workloads complex		on success	List of existing workloads that should be provisioned on the nodes.
		compartment_id string	on success	The OCID of the compartment containing the workload. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
		id string	on success	The Unique Oracle ID (OCID) that is immutable on creation. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
		name string	on success	Name of the Rover Workload Sample: name_example
		object_count string	on success	Number of objects in a workload. Sample: object_count_example
		prefix string	on success	Prefix to filter objects in case it is a bucket. Sample: prefix_example
		range_end string	on success	End of the range in a bucket. Sample: range_end_example
		range_start string	on success	Start of the range in a bucket. Sample: range_start_example
		size string	on success	Size of the workload. Sample: size_example
		work_request_id string	on success	The compute work request id to track progress of custom image exports. Sample: ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx
		workload_type string	on success	The type of workload Sample: workload_type_example
	compartment_id string		on success	The OCID of the compartment containing the RoverCluster. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	customer_shipping_address complex		on success
		address1 string	on success	Address line 1. Sample: address1_example
		address2 string	on success	Address line 2. Sample: address2_example
		address3 string	on success	Address line 3. Sample: address3_example
		address4 string	on success	Address line 4. Sample: address4_example
		addressee string	on success	Addressee in shipping address. Sample: addressee_example
		care_of string	on success	CareOf for shipping address. Sample: care_of_example
		city_or_locality string	on success	city or locality for shipping address. Sample: city_or_locality_example
		country string	on success	country for shipping address. Sample: country_example
		email string	on success	recepient email address. Sample: email_example
		phone_number string	on success	recepient phone number. Sample: phone_number_example
		state_or_region string	on success	state or region for shipping address. Sample: us-phoenix-1
		zipcode string	on success	zipcode for shipping address. Sample: zipcode_example
	data_validation_code string		on success	Validation code returned by data validation tool. Required for return shipping label generation if data import was requested. Sample: data_validation_code_example
	defined_tags dictionary		on success	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"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	delivery_tracking_info string		on success	Tracking information for device shipping. Sample: delivery_tracking_info_example
	display_name string		on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: display_name_example
	enclosure_type string		on success	The type of enclosure rover nodes in this cluster are shipped in. Sample: RUGGADIZED
	exterior_door_code string		on success	Service generated code for the exterior trailer door of the trailer. Sample: exterior_door_code_example
	freeform_tags dictionary		on success	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"}` Sample: {'Department': 'Finance'}
	id string		on success	The OCID of RoverCluster. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	image_export_par string		on success	The link to pre-authenticated request for a bucket where image workloads are moved. Sample: image_export_par_example
	import_compartment_id string		on success	An OCID of a compartment where data will be imported to upon Rover cluster return. Sample: ocid1.importcompartment.oc1..xxxxxxEXAMPLExxxxxx
	import_file_bucket string		on success	Name of a bucket where files from NFS share will be imported to upon Rover cluster return. Sample: import_file_bucket_example
	interior_alarm_disarm_code string		on success	Service generated code to disarm the interior alarm of the trailer. Sample: interior_alarm_disarm_code_example
	is_import_requested boolean		on success	The flag indicating that customer requests data to be imported to OCI upon Rover cluster return. Sample: True
	lifecycle_state string		on success	The current state of the RoverCluster. Sample: CREATING
	lifecycle_state_details string		on success	A property that can contain details on the lifecycle. Sample: lifecycle_state_details_example
	master_key_id string		on success	Customer provided master key ID to encrypt secret information. If not provided, Rover's master key will be used for encryption. Sample: ocid1.masterkey.oc1..xxxxxxEXAMPLExxxxxx
	nodes complex		on success	The summary of nodes that are part of this cluster.
		cluster_id string	on success	The cluster ID if the node is part of a cluster. Sample: ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
		compartment_id string	on success	The OCID of the compartment containing the RoverNode. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
		defined_tags dictionary	on success	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"}}` Sample: {'Operations': {'CostCenter': 'US'}}
		display_name string	on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Sample: display_name_example
		freeform_tags dictionary	on success	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"}` Sample: {'Department': 'Finance'}
		id string	on success	The OCID of the RoverNode. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
		lifecycle_state string	on success	The current state of the RoverNode. Sample: CREATING
		lifecycle_state_details string	on success	A property that can contain details on the lifecycle. Sample: lifecycle_state_details_example
		node_type string	on success	The type of node indicating if it belongs to a cluster Sample: STANDALONE
		serial_number string	on success	Serial number of the node. Sample: serial_number_example
		shape string	on success	The shape of the node. Sample: shape_example
		system_tags dictionary	on success	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}}`
		time_created string	on success	The time the the RoverNode was created. An RFC3339 formatted datetime string Sample: 2013-10-20T19:20:30+01:00
	oracle_shipping_tracking_url string		on success	Tracking Url for the shipped Rover Cluster. Sample: oracle_shipping_tracking_url_example
	point_of_contact string		on success	Name of point of contact for this order if customer is picking up. Sample: point_of_contact_example
	point_of_contact_phone_number string		on success	Phone number of point of contact for this order if customer is picking up. Sample: point_of_contact_phone_number_example
	return_shipping_label_uri string		on success	Uri to download return shipping label. Sample: return_shipping_label_uri_example
	shipping_preference string		on success	Preference for device delivery. Sample: ORACLE_SHIPPED
	shipping_vendor string		on success	Shipping vendor of choice for orace to customer shipping. Sample: shipping_vendor_example
	subscription_id string		on success	ID provided to customer after successful subscription to Rover Stations. Sample: ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
	super_user_password string		on success	Root password for the rover cluster. Sample: example-password
	system_tags dictionary		on success	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}}`
	tags string		on success	The tags associated with tagSlug. Sample: tags_example
	time_created string		on success	The time the the RoverCluster was created. An RFC3339 formatted datetime string Sample: 2013-10-20T19:20:30+01:00
	time_customer_received string		on success	Time when customer received the cluster. Sample: 2013-10-20T19:20:30+01:00
	time_customer_returned string		on success	Time when customer returned the cluster. Sample: 2013-10-20T19:20:30+01:00
	time_pickup_expected string		on success	Expected date when customer wants to pickup the device if they chose customer pickup. Sample: 2013-10-20T19:20:30+01:00
	time_return_window_ends string		on success	End time for the window to pickup the device from customer. Sample: 2013-10-20T19:20:30+01:00
	time_return_window_starts string		on success	Start time for the window to pickup the device from customer. Sample: 2013-10-20T19:20:30+01:00
	unlock_passphrase string		on success	Password to unlock the rover cluster. Sample: unlock_passphrase_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_rover_cluster – Manage a RoverCluster resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶