GenericBmPlatformConfig¶

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

Bases: oci.core.models.platform_config.PlatformConfig

The standard platform configuration of a bare metal instance.

Attributes

`NUMA_NODES_PER_SOCKET_NPS0`	A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig.
`NUMA_NODES_PER_SOCKET_NPS1`	A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig.
`NUMA_NODES_PER_SOCKET_NPS2`	A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig.
`NUMA_NODES_PER_SOCKET_NPS4`	A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig.
`TYPE_AMD_MILAN_BM`	str(object=’’) -> str
`TYPE_AMD_MILAN_BM_GPU`	str(object=’’) -> str
`TYPE_AMD_ROME_BM`	str(object=’’) -> str
`TYPE_AMD_ROME_BM_GPU`	str(object=’’) -> str
`TYPE_AMD_VM`	str(object=’’) -> str
`TYPE_GENERIC_BM`	str(object=’’) -> str
`TYPE_INTEL_ICELAKE_BM`	str(object=’’) -> str
`TYPE_INTEL_SKYLAKE_BM`	str(object=’’) -> str
`TYPE_INTEL_VM`	str(object=’’) -> str
`are_virtual_instructions_enabled`	Gets the are_virtual_instructions_enabled of this GenericBmPlatformConfig.
`config_map`	Gets the config_map of this GenericBmPlatformConfig.
`is_access_control_service_enabled`	Gets the is_access_control_service_enabled of this GenericBmPlatformConfig.
`is_input_output_memory_management_unit_enabled`	Gets the is_input_output_memory_management_unit_enabled of this GenericBmPlatformConfig.
`is_measured_boot_enabled`	Gets the is_measured_boot_enabled of this PlatformConfig.
`is_memory_encryption_enabled`	Gets the is_memory_encryption_enabled of this PlatformConfig.
`is_secure_boot_enabled`	Gets the is_secure_boot_enabled of this PlatformConfig.
`is_symmetric_multi_threading_enabled`	Gets the is_symmetric_multi_threading_enabled of this GenericBmPlatformConfig.
`is_trusted_platform_module_enabled`	Gets the is_trusted_platform_module_enabled of this PlatformConfig.
`numa_nodes_per_socket`	Gets the numa_nodes_per_socket of this GenericBmPlatformConfig.
`percentage_of_cores_enabled`	Gets the percentage_of_cores_enabled of this GenericBmPlatformConfig.
`type`	[Required] Gets the type of this PlatformConfig.

Methods

`__init__`(**kwargs)	Initializes a new GenericBmPlatformConfig object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

NUMA_NODES_PER_SOCKET_NPS0 = 'NPS0'¶: A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig. This constant has a value of “NPS0”

NUMA_NODES_PER_SOCKET_NPS1 = 'NPS1'¶: A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig. This constant has a value of “NPS1”

NUMA_NODES_PER_SOCKET_NPS2 = 'NPS2'¶: A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig. This constant has a value of “NPS2”

NUMA_NODES_PER_SOCKET_NPS4 = 'NPS4'¶: A constant which can be used with the numa_nodes_per_socket property of a GenericBmPlatformConfig. This constant has a value of “NPS4”

TYPE_AMD_MILAN_BM = 'AMD_MILAN_BM'¶

TYPE_AMD_MILAN_BM_GPU = 'AMD_MILAN_BM_GPU'¶

TYPE_AMD_ROME_BM = 'AMD_ROME_BM'¶

TYPE_AMD_ROME_BM_GPU = 'AMD_ROME_BM_GPU'¶

TYPE_AMD_VM = 'AMD_VM'¶

TYPE_GENERIC_BM = 'GENERIC_BM'¶

TYPE_INTEL_ICELAKE_BM = 'INTEL_ICELAKE_BM'¶

TYPE_INTEL_SKYLAKE_BM = 'INTEL_SKYLAKE_BM'¶

TYPE_INTEL_VM = 'INTEL_VM'¶

__init__(**kwargs)¶

Initializes a new GenericBmPlatformConfig object with values from keyword arguments. The default value of the type attribute of this class is GENERIC_BM and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this GenericBmPlatformConfig. Allowed values for this property are: “AMD_MILAN_BM”, “AMD_MILAN_BM_GPU”, “AMD_ROME_BM”, “AMD_ROME_BM_GPU”, “GENERIC_BM”, “INTEL_ICELAKE_BM”, “INTEL_SKYLAKE_BM”, “AMD_VM”, “INTEL_VM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_secure_boot_enabled (bool) – The value to assign to the is_secure_boot_enabled property of this GenericBmPlatformConfig.
is_trusted_platform_module_enabled (bool) – The value to assign to the is_trusted_platform_module_enabled property of this GenericBmPlatformConfig.
is_measured_boot_enabled (bool) – The value to assign to the is_measured_boot_enabled property of this GenericBmPlatformConfig.
is_memory_encryption_enabled (bool) – The value to assign to the is_memory_encryption_enabled property of this GenericBmPlatformConfig.
numa_nodes_per_socket (str) – The value to assign to the numa_nodes_per_socket property of this GenericBmPlatformConfig. Allowed values for this property are: “NPS0”, “NPS1”, “NPS2”, “NPS4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_symmetric_multi_threading_enabled (bool) – The value to assign to the is_symmetric_multi_threading_enabled property of this GenericBmPlatformConfig.
is_access_control_service_enabled (bool) – The value to assign to the is_access_control_service_enabled property of this GenericBmPlatformConfig.
are_virtual_instructions_enabled (bool) – The value to assign to the are_virtual_instructions_enabled property of this GenericBmPlatformConfig.
is_input_output_memory_management_unit_enabled (bool) – The value to assign to the is_input_output_memory_management_unit_enabled property of this GenericBmPlatformConfig.
percentage_of_cores_enabled (int) – The value to assign to the percentage_of_cores_enabled property of this GenericBmPlatformConfig.
config_map (dict(str, str)) – The value to assign to the config_map property of this GenericBmPlatformConfig.

are_virtual_instructions_enabled¶

Gets the are_virtual_instructions_enabled of this GenericBmPlatformConfig. Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.

Returns:	The are_virtual_instructions_enabled of this GenericBmPlatformConfig.
Return type:	bool

config_map¶

Gets the config_map of this GenericBmPlatformConfig. Instance Platform Configuration Configuration Map for flexible setting input.

Returns:	The config_map of this GenericBmPlatformConfig.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_access_control_service_enabled¶

Gets the is_access_control_service_enabled of this GenericBmPlatformConfig. Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.

Returns:	The is_access_control_service_enabled of this GenericBmPlatformConfig.
Return type:	bool

is_input_output_memory_management_unit_enabled¶

Gets the is_input_output_memory_management_unit_enabled of this GenericBmPlatformConfig. Whether the input-output memory management unit is enabled.

Returns:	The is_input_output_memory_management_unit_enabled of this GenericBmPlatformConfig.
Return type:	bool

is_measured_boot_enabled¶

Gets the is_measured_boot_enabled of this PlatformConfig. Whether the Measured Boot feature is enabled on the instance.

Returns:	The is_measured_boot_enabled of this PlatformConfig.
Return type:	bool

is_memory_encryption_enabled¶

Gets the is_memory_encryption_enabled of this PlatformConfig. Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.

Returns:	The is_memory_encryption_enabled of this PlatformConfig.
Return type:	bool

is_secure_boot_enabled¶

Gets the is_secure_boot_enabled of this PlatformConfig. Whether Secure Boot is enabled on the instance.

Returns:	The is_secure_boot_enabled of this PlatformConfig.
Return type:	bool

is_symmetric_multi_threading_enabled¶

Gets the is_symmetric_multi_threading_enabled of this GenericBmPlatformConfig. Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

Returns:	The is_symmetric_multi_threading_enabled of this GenericBmPlatformConfig.
Return type:	bool

is_trusted_platform_module_enabled¶

Gets the is_trusted_platform_module_enabled of this PlatformConfig. Whether the Trusted Platform Module (TPM) is enabled on the instance.

Returns:	The is_trusted_platform_module_enabled of this PlatformConfig.
Return type:	bool

numa_nodes_per_socket¶

Gets the numa_nodes_per_socket of this GenericBmPlatformConfig. The number of NUMA nodes per socket (NPS).

Allowed values for this property are: “NPS0”, “NPS1”, “NPS2”, “NPS4”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The numa_nodes_per_socket of this GenericBmPlatformConfig.
Return type:	str

percentage_of_cores_enabled¶

Gets the percentage_of_cores_enabled of this GenericBmPlatformConfig. The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

Returns:	The percentage_of_cores_enabled of this GenericBmPlatformConfig.
Return type:	int

type¶

[Required] Gets the type of this PlatformConfig. The type of platform being configured.

Allowed values for this property are: “AMD_MILAN_BM”, “AMD_MILAN_BM_GPU”, “AMD_ROME_BM”, “AMD_ROME_BM_GPU”, “GENERIC_BM”, “INTEL_ICELAKE_BM”, “INTEL_SKYLAKE_BM”, “AMD_VM”, “INTEL_VM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this PlatformConfig.
Return type:	str