VirtualNode

class oci.container_engine.models.VirtualNode(**kwargs)

Bases: object

The properties that define a virtual node.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a VirtualNode.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a VirtualNode.

availability_domain

Gets the availability_domain of this VirtualNode.

defined_tags

Gets the defined_tags of this VirtualNode.

display_name

[Required] Gets the display_name of this VirtualNode.

fault_domain

Gets the fault_domain of this VirtualNode.

freeform_tags

Gets the freeform_tags of this VirtualNode.

id

[Required] Gets the id of this VirtualNode.

kubernetes_version

Gets the kubernetes_version of this VirtualNode.

lifecycle_details

Gets the lifecycle_details of this VirtualNode.

lifecycle_state

Gets the lifecycle_state of this VirtualNode.

nsg_ids

Gets the nsg_ids of this VirtualNode.

private_ip

Gets the private_ip of this VirtualNode.

subnet_id

Gets the subnet_id of this VirtualNode.

system_tags

Gets the system_tags of this VirtualNode.

time_created

Gets the time_created of this VirtualNode.

virtual_node_error

Gets the virtual_node_error of this VirtualNode.

virtual_node_pool_id

[Required] Gets the virtual_node_pool_id of this VirtualNode.

Methods:

__init__(**kwargs)

Initializes a new VirtualNode object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a VirtualNode. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new VirtualNode object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this VirtualNode.

  • display_name (str) – The value to assign to the display_name property of this VirtualNode.

  • kubernetes_version (str) – The value to assign to the kubernetes_version property of this VirtualNode.

  • virtual_node_pool_id (str) – The value to assign to the virtual_node_pool_id property of this VirtualNode.

  • availability_domain (str) – The value to assign to the availability_domain property of this VirtualNode.

  • fault_domain (str) – The value to assign to the fault_domain property of this VirtualNode.

  • subnet_id (str) – The value to assign to the subnet_id property of this VirtualNode.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this VirtualNode.

  • private_ip (str) – The value to assign to the private_ip property of this VirtualNode.

  • virtual_node_error (str) – The value to assign to the virtual_node_error property of this VirtualNode.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this VirtualNode. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this VirtualNode.

  • time_created (datetime) – The value to assign to the time_created property of this VirtualNode.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VirtualNode.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VirtualNode.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VirtualNode.

property availability_domain

Gets the availability_domain of this VirtualNode. The name of the availability domain in which this virtual node is placed

Returns

The availability_domain of this VirtualNode.

Return type

str

property defined_tags

Gets the defined_tags of this VirtualNode. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this VirtualNode.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this VirtualNode. The name of the virtual node.

Returns

The display_name of this VirtualNode.

Return type

str

property fault_domain

Gets the fault_domain of this VirtualNode. The fault domain of this virtual node.

Returns

The fault_domain of this VirtualNode.

Return type

str

property freeform_tags

Gets the freeform_tags of this VirtualNode. 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”}

Returns

The freeform_tags of this VirtualNode.

Return type

dict(str, str)

property id

[Required] Gets the id of this VirtualNode. The ocid of the virtual node.

Returns

The id of this VirtualNode.

Return type

str

property kubernetes_version

Gets the kubernetes_version of this VirtualNode. The version of Kubernetes this virtual node is running.

Returns

The kubernetes_version of this VirtualNode.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this VirtualNode. Details about the state of the Virtual Node.

Returns

The lifecycle_details of this VirtualNode.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this VirtualNode. The state of the Virtual Node.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this VirtualNode.

Return type

str

property nsg_ids

Gets the nsg_ids of this VirtualNode. NSG Ids applied to virtual node vnic.

Returns

The nsg_ids of this VirtualNode.

Return type

list[str]

property private_ip

Gets the private_ip of this VirtualNode. The private IP address of this Virtual Node.

Returns

The private_ip of this VirtualNode.

Return type

str

property subnet_id

Gets the subnet_id of this VirtualNode. The OCID of the subnet in which this Virtual Node is placed.

Returns

The subnet_id of this VirtualNode.

Return type

str

property system_tags

Gets the system_tags of this VirtualNode. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this VirtualNode.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this VirtualNode. The time at which the virtual node was created.

Returns

The time_created of this VirtualNode.

Return type

datetime

property virtual_node_error

Gets the virtual_node_error of this VirtualNode. An error that may be associated with the virtual node.

Returns

The virtual_node_error of this VirtualNode.

Return type

str

property virtual_node_pool_id

[Required] Gets the virtual_node_pool_id of this VirtualNode. The ocid of the virtual node pool this virtual node belongs to.

Returns

The virtual_node_pool_id of this VirtualNode.

Return type

str