ClusterNetwork¶

class oci.core.models.ClusterNetwork(**kwargs)¶

Bases: object

A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. Cluster networks with instance pools use instance pools to manage groups of identical instances.

Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group.

If you want to manage instances in the RDMA network independently of each other or use different types of instances in the network group, use compute clusters instead. For details, see ComputeCluster.

Attributes:

`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_RUNNING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_SCALING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a ClusterNetwork.
`compartment_id`	[Required] Gets the compartment_id of this ClusterNetwork.
`defined_tags`	Gets the defined_tags of this ClusterNetwork.
`display_name`	Gets the display_name of this ClusterNetwork.
`freeform_tags`	Gets the freeform_tags of this ClusterNetwork.
`hpc_island_id`	Gets the hpc_island_id of this ClusterNetwork.
`id`	[Required] Gets the id of this ClusterNetwork.
`instance_pools`	Gets the instance_pools of this ClusterNetwork.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ClusterNetwork.
`network_block_ids`	Gets the network_block_ids of this ClusterNetwork.
`placement_configuration`	Gets the placement_configuration of this ClusterNetwork.
`time_created`	[Required] Gets the time_created of this ClusterNetwork.
`time_updated`	[Required] Gets the time_updated of this ClusterNetwork.

Methods:

__init__(**kwargs)

Initializes a new ClusterNetwork object with values from keyword arguments.

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_RUNNING = 'RUNNING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “RUNNING”

LIFECYCLE_STATE_SCALING = 'SCALING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “SCALING”

LIFECYCLE_STATE_STARTING = 'STARTING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “STARTING”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “STOPPING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetwork. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new ClusterNetwork 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 ClusterNetwork.
compartment_id (str) – The value to assign to the compartment_id property of this ClusterNetwork.
hpc_island_id (str) – The value to assign to the hpc_island_id property of this ClusterNetwork.
network_block_ids (list[str]) – The value to assign to the network_block_ids property of this ClusterNetwork.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClusterNetwork.
display_name (str) – The value to assign to the display_name property of this ClusterNetwork.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ClusterNetwork.
instance_pools (list[oci.core.models.InstancePool]) – The value to assign to the instance_pools property of this ClusterNetwork.
placement_configuration (oci.core.models.ClusterNetworkPlacementConfigurationDetails) – The value to assign to the placement_configuration property of this ClusterNetwork.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClusterNetwork. Allowed values for this property are: “PROVISIONING”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ClusterNetwork.
time_updated (datetime) – The value to assign to the time_updated property of this ClusterNetwork.

property compartment_id¶

[Required] Gets the compartment_id of this ClusterNetwork. The OCID of the compartment containing the cluster network.

Returns: The compartment_id of this ClusterNetwork.
Return type: str

property defined_tags¶

Gets the defined_tags of this ClusterNetwork. 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 ClusterNetwork.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this ClusterNetwork. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns: The display_name of this ClusterNetwork.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this ClusterNetwork. 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 ClusterNetwork.
Return type: dict(str, str)

property hpc_island_id¶

Gets the hpc_island_id of this ClusterNetwork. The OCID of the HPC island used by the cluster network.

Returns: The hpc_island_id of this ClusterNetwork.
Return type: str

property id¶

[Required] Gets the id of this ClusterNetwork. The OCID of the cluster network.

Returns: The id of this ClusterNetwork.
Return type: str

property instance_pools¶

Gets the instance_pools of this ClusterNetwork. The instance pools in the cluster network.

Each cluster network can have one instance pool.

Returns: The instance_pools of this ClusterNetwork.
Return type: list[oci.core.models.InstancePool]

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ClusterNetwork. The current state of the cluster network.

Allowed values for this property are: “PROVISIONING”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this ClusterNetwork.
Return type: str

property network_block_ids¶

Gets the network_block_ids of this ClusterNetwork. The list of network block OCIDs of the HPC island.

Returns: The network_block_ids of this ClusterNetwork.
Return type: list[str]

property placement_configuration¶

Gets the placement_configuration of this ClusterNetwork.

Returns: The placement_configuration of this ClusterNetwork.
Return type: oci.core.models.ClusterNetworkPlacementConfigurationDetails

property time_created¶

[Required] Gets the time_created of this ClusterNetwork. The date and time the resource was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns: The time_created of this ClusterNetwork.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this ClusterNetwork. The date and time the resource was updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns: The time_updated of this ClusterNetwork.
Return type: datetime