oracle.oci.oci_database_vm_cluster_network – Manage a VmClusterNetwork resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_database_vm_cluster_network
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a VmClusterNetwork resource in Oracle Cloud Infrastructure
For state=present, creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the CreateCloudVmCluster operation.
This resource has the following action operations in the oracle.oci.oci_database_vm_cluster_network_actions module: add_dbserver_network, remove_dbserver_network.
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
|
|
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
|
|
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 OCID of the compartment.
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 . |
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
|
|||
display_name
string
|
The user-friendly name for the Exadata Cloud@Customer VM cluster network. The name does not need to be unique.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.aliases: name |
|||
dns
list
/ elements=string
|
The list of DNS server IP addresses. Maximum of 3 allowed.
This parameter is updatable.
|
|||
dr_scans
list
/ elements=dictionary
|
The SCAN details for DR network
This parameter is updatable.
|
|||
hostname
string
/ required
|
The Disaster recovery SCAN hostname.
|
|||
ips
list
/ elements=string / required
|
The list of Disaster recovery SCAN IP addresses. Three addresses should be provided.
|
|||
scan_listener_port_tcp
integer
/ required
|
The Disaster recovery SCAN TCPIP port. Default is 1521.
|
|||
exadata_infrastructure_id
string
/ required
|
The Exadata infrastructure OCID.
|
|||
force_create
boolean
|
|
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
|
Free-form tags for this resource. 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.
|
|||
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.
|
|||
ntp
list
/ elements=string
|
The list of NTP server IP addresses. Maximum of 3 allowed.
This parameter is updatable.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|||
scans
list
/ elements=dictionary
|
The SCAN details.
Required for create using state=present.
This parameter is updatable.
|
|||
hostname
string
/ required
|
The SCAN hostname.
|
|||
ips
list
/ elements=string / required
|
The list of SCAN IP addresses. Three addresses should be provided.
|
|||
port
integer
|
**Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521.
|
|||
scan_listener_port_tcp
integer
|
The SCAN TCPIP port. Default is 1521.
|
|||
scan_listener_port_tcp_ssl
integer
|
The SCAN TCPIP SSL port. Default is 2484.
|
|||
state
string
|
|
The state of the VmClusterNetwork.
Use state=present to create or update a VmClusterNetwork.
Use state=absent to delete a VmClusterNetwork.
|
||
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 |
|||
vm_cluster_network_id
string
|
The VM cluster network OCID.
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 |
|||
vm_networks
list
/ elements=dictionary
|
Details of the client and backup networks.
Required for create using state=present.
This parameter is updatable.
|
|||
domain_name
string
|
The network domain name.
|
|||
gateway
string
|
The network gateway.
|
|||
netmask
string
|
The network netmask.
|
|||
network_type
string
/ required
|
|
The network type.
|
||
nodes
list
/ elements=dictionary / required
|
The list of node details.
|
|||
db_server_id
string
|
The Db server associated with the node.
|
|||
hostname
string
/ required
|
The node host name.
|
|||
ip
string
/ required
|
The node IP address.
|
|||
lifecycle_state
string
|
|
The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors.
|
||
vip
string
|
The node virtual IP (VIP) address.
|
|||
vip_hostname
string
|
The node virtual IP (VIP) host name.
|
|||
vlan_id
string
|
The network VLAN ID.
|
|||
wait
boolean
|
|
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 vm_cluster_network
oci_database_vm_cluster_network:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
scans:
- # required
hostname: hostname_example
ips: [ "ips_example" ]
# optional
port: 56
scan_listener_port_tcp: 56
scan_listener_port_tcp_ssl: 56
vm_networks:
- # required
network_type: CLIENT
nodes:
- # required
hostname: hostname_example
ip: ip_example
# optional
vip_hostname: vip_hostname_example
vip: vip_example
lifecycle_state: CREATING
db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx"
netmask: netmask_example
gateway: gateway_example
domain_name: domain_name_example
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
# optional
dns: [ "dns_example" ]
ntp: [ "ntp_example" ]
dr_scans:
- # required
hostname: hostname_example
scan_listener_port_tcp: 56
ips: [ "ips_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update vm_cluster_network
oci_database_vm_cluster_network:
# required
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx"
# optional
scans:
- # required
hostname: hostname_example
ips: [ "ips_example" ]
# optional
port: 56
scan_listener_port_tcp: 56
scan_listener_port_tcp_ssl: 56
dns: [ "dns_example" ]
ntp: [ "ntp_example" ]
vm_networks:
- # required
network_type: CLIENT
nodes:
- # required
hostname: hostname_example
ip: ip_example
# optional
vip_hostname: vip_hostname_example
vip: vip_example
lifecycle_state: CREATING
db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx"
netmask: netmask_example
gateway: gateway_example
domain_name: domain_name_example
dr_scans:
- # required
hostname: hostname_example
scan_listener_port_tcp: 56
ips: [ "ips_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update vm_cluster_network using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_vm_cluster_network:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
# optional
scans:
- # required
hostname: hostname_example
ips: [ "ips_example" ]
# optional
port: 56
scan_listener_port_tcp: 56
scan_listener_port_tcp_ssl: 56
dns: [ "dns_example" ]
ntp: [ "ntp_example" ]
vm_networks:
- # required
network_type: CLIENT
nodes:
- # required
hostname: hostname_example
ip: ip_example
# optional
vip_hostname: vip_hostname_example
vip: vip_example
lifecycle_state: CREATING
db_server_id: "ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vlan_id: "ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx"
netmask: netmask_example
gateway: gateway_example
domain_name: domain_name_example
dr_scans:
- # required
hostname: hostname_example
scan_listener_port_tcp: 56
ips: [ "ips_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete vm_cluster_network
oci_database_vm_cluster_network:
# required
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
vm_cluster_network_id: "ocid1.vmclusternetwork.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete vm_cluster_network using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_database_vm_cluster_network:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
exadata_infrastructure_id: "ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
vm_cluster_network
complex
|
on success |
Details of the VmClusterNetwork resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns': [], 'dr_scans': [{'hostname': 'hostname_example', 'ips': [], 'scan_listener_port_tcp': 56}], 'exadata_infrastructure_id': 'ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'ntp': [], 'scans': [{'hostname': 'hostname_example', 'ips': [], 'port': 56, 'scan_listener_port_tcp': 56, 'scan_listener_port_tcp_ssl': 56}], 'time_created': '2013-10-20T19:20:30+01:00', 'vm_cluster_id': 'ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx', 'vm_networks': [{'domain_name': 'domain_name_example', 'gateway': 'gateway_example', 'netmask': 'netmask_example', 'network_type': 'CLIENT', 'nodes': [{'db_server_id': 'ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx', 'hostname': 'hostname_example', 'ip': 'ip_example', 'lifecycle_state': 'CREATING', 'vip': 'vip_example', 'vip_hostname': 'vip_hostname_example'}], 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx'}]}
|
|||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||
display_name
string
|
on success |
The user-friendly name for the VM cluster network. The name does not need to be unique.
Sample:
display_name_example
|
|||
dns
list
/ elements=string
|
on success |
The list of DNS server IP addresses. Maximum of 3 allowed.
|
|||
dr_scans
complex
|
on success |
The SCAN details for DR network
|
|||
hostname
string
|
on success |
The Disaster recovery SCAN hostname.
Sample:
hostname_example
|
|||
ips
list
/ elements=string
|
on success |
The list of Disaster recovery SCAN IP addresses. Three addresses should be provided.
|
|||
scan_listener_port_tcp
integer
|
on success |
The Disaster recovery SCAN TCPIP port. Default is 1521.
Sample:
56
|
|||
exadata_infrastructure_id
string
|
on success |
The OCID of the Exadata infrastructure.
Sample:
ocid1.exadatainfrastructure.oc1..xxxxxxEXAMPLExxxxxx
|
|||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. 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 VM cluster network.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
lifecycle_details
string
|
on success |
Additional information about the current lifecycle state.
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The current state of the VM cluster network. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. NEEDS_ATTENTION - The resource is in needs attention state as some of it's child nodes are not validated and unusable by VM cluster.
Sample:
CREATING
|
|||
ntp
list
/ elements=string
|
on success |
The list of NTP server IP addresses. Maximum of 3 allowed.
|
|||
scans
complex
|
on success |
The SCAN details.
|
|||
hostname
string
|
on success |
The SCAN hostname.
Sample:
hostname_example
|
|||
ips
list
/ elements=string
|
on success |
The list of SCAN IP addresses. Three addresses should be provided.
|
|||
port
integer
|
on success |
**Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521.
Sample:
56
|
|||
scan_listener_port_tcp
integer
|
on success |
The SCAN TCPIP port. Default is 1521.
Sample:
56
|
|||
scan_listener_port_tcp_ssl
integer
|
on success |
The SCAN TCPIP SSL port. Default is 2484.
Sample:
56
|
|||
time_created
string
|
on success |
The date and time when the VM cluster network was created.
Sample:
2013-10-20T19:20:30+01:00
|
|||
vm_cluster_id
string
|
on success |
The OCID of the associated VM Cluster.
Sample:
ocid1.vmcluster.oc1..xxxxxxEXAMPLExxxxxx
|
|||
vm_networks
complex
|
on success |
Details of the client and backup networks.
|
|||
domain_name
string
|
on success |
The network domain name.
Sample:
domain_name_example
|
|||
gateway
string
|
on success |
The network gateway.
Sample:
gateway_example
|
|||
netmask
string
|
on success |
The network netmask.
Sample:
netmask_example
|
|||
network_type
string
|
on success |
The network type.
Sample:
CLIENT
|
|||
nodes
complex
|
on success |
The list of node details.
|
|||
db_server_id
string
|
on success |
The Db server associated with the node.
Sample:
ocid1.dbserver.oc1..xxxxxxEXAMPLExxxxxx
|
|||
hostname
string
|
on success |
The node host name.
Sample:
hostname_example
|
|||
ip
string
|
on success |
The node IP address.
Sample:
ip_example
|
|||
lifecycle_state
string
|
on success |
The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors.
Sample:
CREATING
|
|||
vip
string
|
on success |
The node virtual IP (VIP) address.
Sample:
vip_example
|
|||
vip_hostname
string
|
on success |
The node virtual IP (VIP) host name.
Sample:
vip_hostname_example
|
|||
vlan_id
string
|
on success |
The network VLAN ID.
Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)