oracle.oci.oci_tenant_manager_control_plane_sender_invitation_facts – Fetches details about one or multiple SenderInvitation 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_tenant_manager_control_plane_sender_invitation_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Return a (paginated) list of sender invitations.

  • If sender_invitation_id is specified, the details of a single SenderInvitation 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.
compartment_id
string
The ID of the compartment in which to list resources.
Required to list multiple sender_invitations.
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
  • ACTIVE
  • INACTIVE
  • UPDATING
  • FAILED
  • TERMINATED
The lifecycle state of the resource.
recipient_tenancy_id
string
The tenancy that the invitation is addressed to.
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.
sender_invitation_id
string
OCID of the sender invitation to retrieve.
Required to get a specific sender_invitation.

aliases: id
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, whether 'asc' or 'desc'.
status
string
    Choices:
  • PENDING
  • CANCELED
  • ACCEPTED
  • EXPIRED
  • FAILED
The status of the sender invitation.
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 sender_invitation
  oci_tenant_manager_control_plane_sender_invitation_facts:
    # required
    sender_invitation_id: "ocid1.senderinvitation.oc1..xxxxxxEXAMPLExxxxxx"

- name: List sender_invitations
  oci_tenant_manager_control_plane_sender_invitation_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    recipient_tenancy_id: "ocid1.recipienttenancy.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    status: PENDING
    display_name: display_name_example
    sort_by: timeCreated
    sort_order: ASC

Return Values

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

Key Returned Description
sender_invitations
complex
on success
List of SenderInvitation resources

Sample:
[{'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', 'recipient_email_address': 'recipient_email_address_example', 'recipient_invitation_id': 'ocid1.recipientinvitation.oc1..xxxxxxEXAMPLExxxxxx', 'recipient_tenancy_id': 'ocid1.recipienttenancy.oc1..xxxxxxEXAMPLExxxxxx', 'status': 'PENDING', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
OCID of the sender tenancy.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-created name to describe the invitation. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
OCID of the sender invitation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
Lifecycle state of the sender invitation.

Sample:
CREATING
 
recipient_email_address
string
on success
Email address of the recipient.

Sample:
recipient_email_address_example
 
recipient_invitation_id
string
on success
OCID of the corresponding recipient invitation.

Sample:
ocid1.recipientinvitation.oc1..xxxxxxEXAMPLExxxxxx
 
recipient_tenancy_id
string
on success
OCID of the recipient tenancy.

Sample:
ocid1.recipienttenancy.oc1..xxxxxxEXAMPLExxxxxx
 
status
string
on success
Status of the sender invitation.

Sample:
PENDING
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
Date-time when this sender invitation was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Date-time when this sender invitation was last updated.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)