oracle.oci.oci_container_engine_virtual_node_pool_facts – Fetches details about one or multiple VirtualNodePool resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List all the virtual node pools in a compartment, and optionally filter by cluster.

  • If virtual_node_pool_id is specified, the details of a single VirtualNodePool 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
  • 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_id
string
The OCID of the cluster.
compartment_id
string
The OCID of the compartment.
Required to list multiple virtual_node_pools.
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
Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_state
list / elements=string
    Choices:
  • CREATING
  • ACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
  • NEEDS_ATTENTION
A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name.
name
string
The name to filter on.
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.
sort_by
string
    Choices:
  • ID
  • NAME
  • TIME_CREATED
The optional field to sort the results by.
sort_order
string
    Choices:
  • ASC
  • DESC
The optional order in which to sort the results.
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
virtual_node_pool_id
string
The OCID of the virtual node pool.
Required to get a specific virtual_node_pool.

aliases: id

Examples

- name: Get a specific virtual_node_pool
  oci_container_engine_virtual_node_pool_facts:
    # required
    virtual_node_pool_id: "ocid1.virtualnodepool.oc1..xxxxxxEXAMPLExxxxxx"

- name: List virtual_node_pools
  oci_container_engine_virtual_node_pool_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    cluster_id: "ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    sort_order: ASC
    sort_by: ID
    lifecycle_state: [ "CREATING" ]

Return Values

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

Key Returned Description
virtual_node_pools
complex
on success
List of VirtualNodePool resources

Sample:
[{'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', 'initial_virtual_node_labels': [{'key': 'key_example', 'value': 'value_example'}], 'kubernetes_version': 'kubernetes_version_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'nsg_ids': [], 'placement_configurations': [{'availability_domain': 'Uocm:PHX-AD-1', 'fault_domain': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}], 'pod_configuration': {'nsg_ids': [], 'shape': 'shape_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'size': 56, 'system_tags': {}, 'taints': [{'effect': 'effect_example', 'key': 'key_example', 'value': 'value_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'virtual_node_tags': {'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}}}]
 
cluster_id
string
on success
The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

Sample:
ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
Compartment of the virtual node pool.

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. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Display name of the virtual node pool. This is a non-unique value.

Sample:
display_name_example
 
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 virtual node pool.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
initial_virtual_node_labels
complex
on success
Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.
   
key
string
on success
The key of the pair.

Sample:
key_example
   
value
string
on success
The value of the pair.

Sample:
value_example
 
kubernetes_version
string
on success
The version of Kubernetes running on the nodes in the node pool.

Sample:
kubernetes_version_example
 
lifecycle_details
string
on success
Details about the state of the Virtual Node Pool.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The state of the Virtual Node Pool.

Sample:
CREATING
 
nsg_ids
list / elements=string
on success
List of network security group id's applied to the Virtual Node VNIC.
 
placement_configurations
complex
on success
The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
   
availability_domain
string
on success
The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
   
fault_domain
list / elements=string
on success
The fault domain of this virtual node.
   
subnet_id
string
on success
The OCID of the subnet in which to place virtual nodes.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
pod_configuration
complex
on success
The pod configuration for pods run on virtual nodes of this virtual node pool.
   
nsg_ids
list / elements=string
on success
List of network security group IDs applied to the Pod VNIC.
   
shape
string
on success
Shape of the pods.

Sample:
shape_example
   
subnet_id
string
on success
The regional subnet where pods' VNIC will be placed.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
size
integer
on success
The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

Sample:
56
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
taints
complex
on success
A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
   
effect
string
on success
The effect of the pair.

Sample:
effect_example
   
key
string
on success
The key of the pair.

Sample:
key_example
   
value
string
on success
The value of the pair.

Sample:
value_example
 
time_created
string
on success
The time the virtual node pool was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the virtual node pool was updated.

Sample:
2013-10-20T19:20:30+01:00
 
virtual_node_tags
complex
on success

   
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. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
   
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'}


Authors

  • Oracle (@oracle)