oracle / oracle.oci / 4.32.0 / module / oci_compute_volume_attachment_facts Fetches details about one or multiple VolumeAttachment resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_volume_attachment_facts (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
Fetches details about one or multiple VolumeAttachment resources in Oracle Cloud Infrastructure
Lists the volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, volume OCID, or both.
Currently, the only supported volume attachment type are L(IScsiVolumeAttachment,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/iaas/latest/IScsiVolumeAttachment/) and L(ParavirtualizedVolumeAttachment,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/ParavirtualizedVolumeAttachment/).
If I(volume_attachment_id) is specified, the details of a single VolumeAttachment will be returned.
- name: Get a specific volume_attachment oci_compute_volume_attachment_facts: # required volume_attachment_id: "ocid1.volumeattachment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List volume_attachments oci_compute_volume_attachment_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional availability_domain: Uocm:PHX-AD-1 instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx" volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str volume_id: description: - The OCID of the volume. type: str cert_bundle: description: - 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. type: str instance_id: description: - The OCID of the instance. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str display_name: description: Use I(display_name) along with the other options to return only resources that match the given display name exactly. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple volume_attachments. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str availability_domain: description: - The name of the availability domain. - 'Example: `Uocm:PHX-AD-1`' type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str volume_attachment_id: aliases: - id description: - The OCID of the volume attachment. - Required to get a specific volume_attachment. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
volume_attachments: contains: attachment_type: description: - The type of volume attachment. returned: on success sample: emulated type: str availability_domain: description: - The availability domain of an instance. - 'Example: `Uocm:PHX-AD-1`' returned: on success sample: Uocm:PHX-AD-1 type: str chap_secret: description: - The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".) returned: on success sample: chap_secret_example type: str chap_username: description: - The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See L(RFC 1994,https://tools.ietf.org/html/rfc1994) for more on CHAP. - 'Example: `ocid1.volume.oc1.phx.<unique_ID>`' returned: on success sample: chap_username_example type: str compartment_id: description: - The OCID of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str device: description: - The device name. returned: on success sample: device_example type: str display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str encryption_in_transit_type: description: - Refer the top-level definition of encryptionInTransitType. The default value is NONE. returned: on success sample: NONE type: str id: description: - The OCID of the volume attachment. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str instance_id: description: - The OCID of the instance the volume is attached to. returned: on success sample: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx type: str ipv4: description: - The volume's iSCSI IP address. - 'Example: `169.254.0.2`' returned: on success sample: ipv4_example type: str iqn: description: - The target volume's iSCSI Qualified Name in the format defined by L(RFC 3720,https://tools.ietf.org/html/rfc3720#page-32). - 'Example: `iqn.2015-12.us.oracle.com:<CHAP_username>`' returned: on success sample: iqn_example type: str is_agent_auto_iscsi_login_enabled: description: - Whether Oracle Cloud Agent is enabled perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments. returned: on success sample: true type: bool is_multipath: description: - Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment. returned: on success sample: true type: bool is_pv_encryption_in_transit_enabled: description: - Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not. returned: on success sample: true type: bool is_read_only: description: - Whether the attachment was created in read-only mode. returned: on success sample: true type: bool is_shareable: description: - Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified. returned: on success sample: true type: bool iscsi_attach_commands: description: - Commands to attach the iSCSI block volume. Empty if attachment_type is not iscsi. returned: on success sample: - sudo iscsiadm -m node -o new -T IQN -p IP:PORT - sudo iscsiadm -m node -o update ... type: list iscsi_detach_commands: description: - Commands to detach the iSCSI block volume. Empty if attachment_type is not iscsi. returned: on success sample: - sudo iscsiadm -m node -T IQN -p IP:PORT -u - sudo iscsiadm -m node -o delete -T IQN type: list iscsi_login_state: description: - The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. returned: on success sample: UNKNOWN type: str lifecycle_state: description: - The current state of the volume attachment. returned: on success sample: ATTACHING type: str multipath_devices: contains: ipv4: description: - The volume's iSCSI IP address. - 'Example: `169.254.2.2`' returned: on success sample: ipv4_example type: str iqn: description: - The target volume's iSCSI Qualified Name in the format defined by L(RFC 3720,https://tools.ietf.org/html/rfc3720#page-32). - 'Example: `iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195`' returned: on success sample: iqn_example type: str port: description: - The volume's iSCSI port, usually port 860 or 3260. - 'Example: `3260`' returned: on success sample: 56 type: int description: - A list of secondary multipath devices returned: on success type: complex port: description: - The volume's iSCSI port, usually port 860 or 3260. - 'Example: `3260`' returned: on success sample: 56 type: int time_created: description: - The date and time the volume was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str volume_id: description: - The OCID of the volume. returned: on success sample: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx type: str description: - List of VolumeAttachment resources returned: on success sample: - attachment_type: emulated availability_domain: Uocm:PHX-AD-1 chap_secret: chap_secret_example chap_username: chap_username_example compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx device: device_example display_name: display_name_example encryption_in_transit_type: NONE id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx instance_id: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx ipv4: ipv4_example iqn: iqn_example is_agent_auto_iscsi_login_enabled: true is_multipath: true is_pv_encryption_in_transit_enabled: true is_read_only: true is_shareable: true iscsi_attach_commands: - sudo iscsiadm -m node -o new -T IQN -p IP:PORT - sudo iscsiadm -m node -o update ... iscsi_detach_commands: - sudo iscsiadm -m node -T IQN -p IP:PORT -u - sudo iscsiadm -m node -o delete -T IQN iscsi_login_state: UNKNOWN lifecycle_state: ATTACHING multipath_devices: - ipv4: ipv4_example iqn: iqn_example port: 56 port: 56 time_created: '2013-10-20T19:20:30+01:00' volume_id: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx type: complex