oracle.oci.oci_rover_cluster_facts – Fetches details about one or multiple RoverCluster resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple RoverCluster resources in Oracle Cloud Infrastructure

  • Returns a list of RoverClusters.

  • If rover_cluster_id is specified, the details of a single RoverCluster will be returned.

Requirements

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

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
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_type
string
    Choices:
  • STANDALONE
  • STATION
A filter to return only Clusters of type matched with the given cluster type.
compartment_id
string
The OCID of the compartment in which to list resources.
Required to list multiple rover_clusters.
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.
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only resources their lifecycleState matches the given lifecycleState.
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 to get a specific rover_cluster.

aliases: id
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: Get a specific rover_cluster
  oci_rover_cluster_facts:
    # required
    rover_cluster_id: "ocid1.rovercluster.oc1..xxxxxxEXAMPLExxxxxx"

- name: List rover_clusters
  oci_rover_cluster_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    cluster_type: STANDALONE
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
rover_clusters
complex
on success
List of RoverCluster resources

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.
Returned for get operation

   
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
Returned for get operation

   
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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

Sample:
RUGGADIZED
 
exterior_door_code
string
on success
Service generated code for the exterior trailer door of the trailer.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

Sample:
import_file_bucket_example
 
interior_alarm_disarm_code
string
on success
Service generated code to disarm the interior alarm of the trailer.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

Sample:
point_of_contact_phone_number_example
 
return_shipping_label_uri
string
on success
Uri to download return shipping label.
Returned for get operation

Sample:
return_shipping_label_uri_example
 
shipping_preference
string
on success
Preference for device delivery.
Returned for get operation

Sample:
ORACLE_SHIPPED
 
shipping_vendor
string
on success
Shipping vendor of choice for orace to customer shipping.
Returned for get operation

Sample:
shipping_vendor_example
 
subscription_id
string
on success
ID provided to customer after successful subscription to Rover Stations.
Returned for get operation

Sample:
ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
 
super_user_password
string
on success
Root password for the rover cluster.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

Sample:
2013-10-20T19:20:30+01:00
 
time_customer_returned
string
on success
Time when customer returned the cluster.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

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.
Returned for get operation

Sample:
2013-10-20T19:20:30+01:00
 
unlock_passphrase
string
on success
Password to unlock the rover cluster.
Returned for get operation

Sample:
unlock_passphrase_example


Authors

  • Oracle (@oracle)