virtual_nodes

Creates, updates, deletes, gets or lists a virtual_nodes resource.

Overview

Name	virtual_nodes
Type	Resource
Id	oci.container_engine.virtual_nodes

Fields

The following fields are returned by SELECT queries:

get

The virtual node.

Name	Datatype	Description
id	string	The ocid of the virtual node. (example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw)
availabilityDomain	string	The name of the availability domain in which this virtual node is placed
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	The name of the virtual node. (example: My Kubernetes virtual Node)
faultDomain	string	The fault domain of this virtual node.
freeformTags	object	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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
kubernetesVersion	string	The version of Kubernetes this virtual node is running. (example: v1.9.4)
lifecycleDetails	string	Details about the state of the Virtual Node.
lifecycleState	string	The state of the Virtual Node. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED, NEEDS_ATTENTION) (x-obmcs-top-level-enum: #/definitions/VirtualNodeLifecycleState)
nsgIds	array	NSG Ids applied to virtual node vnic.
privateIp	string	The private IP address of this Virtual Node.
subnetId	string	The OCID of the subnet in which this Virtual Node is placed.
systemTags	object	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated	string (date-time)	The time at which the virtual node was created. (example: 2017-07-21T16:11:29Z)
virtualNodeError	string	An error that may be associated with the virtual node.
virtualNodePoolId	string	The ocid of the virtual node pool this virtual node belongs to. (example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq)

list

The properties that define a virtual node summary.

Name	Datatype	Description
id	string	The ocid of the virtual node. (example: ocid1.virtualnode.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgyswgycdoy3tcmtctmyw)
availabilityDomain	string	The name of the availability domain in which this virtual node is placed
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	The name of the virtual node. (example: My Kubernetes virtual Node)
faultDomain	string	The fault domain of this virtual node.
freeformTags	object	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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
kubernetesVersion	string	The version of Kubernetes this virtual node is running. (example: v1.9.4)
lifecycleDetails	string	Details about the state of the Virtual Node.
lifecycleState	string	The state of the Virtual Node. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED, NEEDS_ATTENTION) (x-obmcs-top-level-enum: #/definitions/VirtualNodeLifecycleState)
nsgIds	array	NSG Ids applied to virtual node vnic.
privateIp	string	The private IP address of this Virtual Node.
subnetId	string	The OCID of the subnet in which this Virtual Node is placed.
systemTags	object	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated	string (date-time)	The time at which the virtual node was created. (example: 2017-07-21T16:11:29Z)
virtualNodeError	string	An error that may be associated with the virtual node.
virtualNodePoolId	string	The ocid of the virtual node pool this virtual node belongs to. (example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	virtualNodePoolId, virtualNodeId, region	opc-request-id	Get the details of a virtual node.
list	select	virtualNodePoolId, region	opc-request-id, name, limit, page, sortOrder, sortBy	List virtual nodes in a virtual node pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
virtualNodeId	string	The OCID of the virtual node.
virtualNodePoolId	string	The OCID of the virtual node pool.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
name	string	The name to filter on.
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The optional field to sort the results by.
sortOrder	string	The optional order in which to sort the results.

SELECT examples

get

Get the details of a virtual node.

SELECT
id,
availabilityDomain,
definedTags,
displayName,
faultDomain,
freeformTags,
kubernetesVersion,
lifecycleDetails,
lifecycleState,
nsgIds,
privateIp,
subnetId,
systemTags,
timeCreated,
virtualNodeError,
virtualNodePoolId
FROM oci.container_engine.virtual_nodes
WHERE virtualNodePoolId = '{{ virtualNodePoolId }}' -- required
AND virtualNodeId = '{{ virtualNodeId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

List virtual nodes in a virtual node pool.

SELECT
id,
availabilityDomain,
definedTags,
displayName,
faultDomain,
freeformTags,
kubernetesVersion,
lifecycleDetails,
lifecycleState,
nsgIds,
privateIp,
subnetId,
systemTags,
timeCreated,
virtualNodeError,
virtualNodePoolId
FROM oci.container_engine.virtual_nodes
WHERE virtualNodePoolId = '{{ virtualNodePoolId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND name = '{{ name }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
;