oci 2.110.2__py3-none-any.whl → 2.112.0__py3-none-any.whl

oci/core/models/generic_bm_launch_instance_platform_config.py

@@ -0,0 +1,349 @@
+# coding: utf-8
+# Copyright (c) 2016, 2023, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
+
+from .launch_instance_platform_config import LaunchInstancePlatformConfig
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class GenericBmLaunchInstancePlatformConfig(LaunchInstancePlatformConfig):
+    """
+    The standard platform configuration to be used when launching a bare metal instance.
+    """
+
+    #: A constant which can be used with the numa_nodes_per_socket property of a GenericBmLaunchInstancePlatformConfig.
+    #: This constant has a value of "NPS0"
+    NUMA_NODES_PER_SOCKET_NPS0 = "NPS0"
+
+    #: A constant which can be used with the numa_nodes_per_socket property of a GenericBmLaunchInstancePlatformConfig.
+    #: This constant has a value of "NPS1"
+    NUMA_NODES_PER_SOCKET_NPS1 = "NPS1"
+
+    #: A constant which can be used with the numa_nodes_per_socket property of a GenericBmLaunchInstancePlatformConfig.
+    #: This constant has a value of "NPS2"
+    NUMA_NODES_PER_SOCKET_NPS2 = "NPS2"
+
+    #: A constant which can be used with the numa_nodes_per_socket property of a GenericBmLaunchInstancePlatformConfig.
+    #: This constant has a value of "NPS4"
+    NUMA_NODES_PER_SOCKET_NPS4 = "NPS4"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new GenericBmLaunchInstancePlatformConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.core.models.GenericBmLaunchInstancePlatformConfig.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):
+
+        :param type:
+            The value to assign to the type property of this GenericBmLaunchInstancePlatformConfig.
+            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"
+        :type type: str
+
+        :param is_secure_boot_enabled:
+            The value to assign to the is_secure_boot_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_secure_boot_enabled: bool
+
+        :param is_trusted_platform_module_enabled:
+            The value to assign to the is_trusted_platform_module_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_trusted_platform_module_enabled: bool
+
+        :param is_measured_boot_enabled:
+            The value to assign to the is_measured_boot_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_measured_boot_enabled: bool
+
+        :param is_memory_encryption_enabled:
+            The value to assign to the is_memory_encryption_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_memory_encryption_enabled: bool
+
+        :param numa_nodes_per_socket:
+            The value to assign to the numa_nodes_per_socket property of this GenericBmLaunchInstancePlatformConfig.
+            Allowed values for this property are: "NPS0", "NPS1", "NPS2", "NPS4"
+        :type numa_nodes_per_socket: str
+
+        :param is_symmetric_multi_threading_enabled:
+            The value to assign to the is_symmetric_multi_threading_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_symmetric_multi_threading_enabled: bool
+
+        :param is_access_control_service_enabled:
+            The value to assign to the is_access_control_service_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_access_control_service_enabled: bool
+
+        :param are_virtual_instructions_enabled:
+            The value to assign to the are_virtual_instructions_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type are_virtual_instructions_enabled: bool
+
+        :param is_input_output_memory_management_unit_enabled:
+            The value to assign to the is_input_output_memory_management_unit_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type is_input_output_memory_management_unit_enabled: bool
+
+        :param percentage_of_cores_enabled:
+            The value to assign to the percentage_of_cores_enabled property of this GenericBmLaunchInstancePlatformConfig.
+        :type percentage_of_cores_enabled: int
+
+        :param config_map:
+            The value to assign to the config_map property of this GenericBmLaunchInstancePlatformConfig.
+        :type config_map: dict(str, str)
+
+        """
+        self.swagger_types = {
+            'type': 'str',
+            'is_secure_boot_enabled': 'bool',
+            'is_trusted_platform_module_enabled': 'bool',
+            'is_measured_boot_enabled': 'bool',
+            'is_memory_encryption_enabled': 'bool',
+            'numa_nodes_per_socket': 'str',
+            'is_symmetric_multi_threading_enabled': 'bool',
+            'is_access_control_service_enabled': 'bool',
+            'are_virtual_instructions_enabled': 'bool',
+            'is_input_output_memory_management_unit_enabled': 'bool',
+            'percentage_of_cores_enabled': 'int',
+            'config_map': 'dict(str, str)'
+        }
+
+        self.attribute_map = {
+            'type': 'type',
+            'is_secure_boot_enabled': 'isSecureBootEnabled',
+            'is_trusted_platform_module_enabled': 'isTrustedPlatformModuleEnabled',
+            'is_measured_boot_enabled': 'isMeasuredBootEnabled',
+            'is_memory_encryption_enabled': 'isMemoryEncryptionEnabled',
+            'numa_nodes_per_socket': 'numaNodesPerSocket',
+            'is_symmetric_multi_threading_enabled': 'isSymmetricMultiThreadingEnabled',
+            'is_access_control_service_enabled': 'isAccessControlServiceEnabled',
+            'are_virtual_instructions_enabled': 'areVirtualInstructionsEnabled',
+            'is_input_output_memory_management_unit_enabled': 'isInputOutputMemoryManagementUnitEnabled',
+            'percentage_of_cores_enabled': 'percentageOfCoresEnabled',
+            'config_map': 'configMap'
+        }
+
+        self._type = None
+        self._is_secure_boot_enabled = None
+        self._is_trusted_platform_module_enabled = None
+        self._is_measured_boot_enabled = None
+        self._is_memory_encryption_enabled = None
+        self._numa_nodes_per_socket = None
+        self._is_symmetric_multi_threading_enabled = None
+        self._is_access_control_service_enabled = None
+        self._are_virtual_instructions_enabled = None
+        self._is_input_output_memory_management_unit_enabled = None
+        self._percentage_of_cores_enabled = None
+        self._config_map = None
+        self._type = 'GENERIC_BM'
+
+    @property
+    def numa_nodes_per_socket(self):
+        """
+        Gets the numa_nodes_per_socket of this GenericBmLaunchInstancePlatformConfig.
+        The number of NUMA nodes per socket (NPS).
+
+        Allowed values for this property are: "NPS0", "NPS1", "NPS2", "NPS4"
+
+
+        :return: The numa_nodes_per_socket of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: str
+        """
+        return self._numa_nodes_per_socket
+
+    @numa_nodes_per_socket.setter
+    def numa_nodes_per_socket(self, numa_nodes_per_socket):
+        """
+        Sets the numa_nodes_per_socket of this GenericBmLaunchInstancePlatformConfig.
+        The number of NUMA nodes per socket (NPS).
+
+
+        :param numa_nodes_per_socket: The numa_nodes_per_socket of this GenericBmLaunchInstancePlatformConfig.
+        :type: str
+        """
+        allowed_values = ["NPS0", "NPS1", "NPS2", "NPS4"]
+        if not value_allowed_none_or_none_sentinel(numa_nodes_per_socket, allowed_values):
+            raise ValueError(
+                "Invalid value for `numa_nodes_per_socket`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._numa_nodes_per_socket = numa_nodes_per_socket
+
+    @property
+    def is_symmetric_multi_threading_enabled(self):
+        """
+        Gets the is_symmetric_multi_threading_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :return: The is_symmetric_multi_threading_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: bool
+        """
+        return self._is_symmetric_multi_threading_enabled
+
+    @is_symmetric_multi_threading_enabled.setter
+    def is_symmetric_multi_threading_enabled(self, is_symmetric_multi_threading_enabled):
+        """
+        Sets the is_symmetric_multi_threading_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :param is_symmetric_multi_threading_enabled: The is_symmetric_multi_threading_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :type: bool
+        """
+        self._is_symmetric_multi_threading_enabled = is_symmetric_multi_threading_enabled
+
+    @property
+    def is_access_control_service_enabled(self):
+        """
+        Gets the is_access_control_service_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :return: The is_access_control_service_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: bool
+        """
+        return self._is_access_control_service_enabled
+
+    @is_access_control_service_enabled.setter
+    def is_access_control_service_enabled(self, is_access_control_service_enabled):
+        """
+        Sets the is_access_control_service_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :param is_access_control_service_enabled: The is_access_control_service_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :type: bool
+        """
+        self._is_access_control_service_enabled = is_access_control_service_enabled
+
+    @property
+    def are_virtual_instructions_enabled(self):
+        """
+        Gets the are_virtual_instructions_enabled of this GenericBmLaunchInstancePlatformConfig.
+        Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes
+        or VT-x for Intel shapes.
+
+
+        :return: The are_virtual_instructions_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: bool
+        """
+        return self._are_virtual_instructions_enabled
+
+    @are_virtual_instructions_enabled.setter
+    def are_virtual_instructions_enabled(self, are_virtual_instructions_enabled):
+        """
+        Sets the are_virtual_instructions_enabled of this GenericBmLaunchInstancePlatformConfig.
+        Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes
+        or VT-x for Intel shapes.
+
+
+        :param are_virtual_instructions_enabled: The are_virtual_instructions_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :type: bool
+        """
+        self._are_virtual_instructions_enabled = are_virtual_instructions_enabled
+
+    @property
+    def is_input_output_memory_management_unit_enabled(self):
+        """
+        Gets the is_input_output_memory_management_unit_enabled of this GenericBmLaunchInstancePlatformConfig.
+        Whether the input-output memory management unit is enabled.
+
+
+        :return: The is_input_output_memory_management_unit_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: bool
+        """
+        return self._is_input_output_memory_management_unit_enabled
+
+    @is_input_output_memory_management_unit_enabled.setter
+    def is_input_output_memory_management_unit_enabled(self, is_input_output_memory_management_unit_enabled):
+        """
+        Sets the is_input_output_memory_management_unit_enabled of this GenericBmLaunchInstancePlatformConfig.
+        Whether the input-output memory management unit is enabled.
+
+
+        :param is_input_output_memory_management_unit_enabled: The is_input_output_memory_management_unit_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :type: bool
+        """
+        self._is_input_output_memory_management_unit_enabled = is_input_output_memory_management_unit_enabled
+
+    @property
+    def percentage_of_cores_enabled(self):
+        """
+        Gets the percentage_of_cores_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :return: The percentage_of_cores_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: int
+        """
+        return self._percentage_of_cores_enabled
+
+    @percentage_of_cores_enabled.setter
+    def percentage_of_cores_enabled(self, percentage_of_cores_enabled):
+        """
+        Sets the percentage_of_cores_enabled of this GenericBmLaunchInstancePlatformConfig.
+        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.
+
+
+        :param percentage_of_cores_enabled: The percentage_of_cores_enabled of this GenericBmLaunchInstancePlatformConfig.
+        :type: int
+        """
+        self._percentage_of_cores_enabled = percentage_of_cores_enabled
+
+    @property
+    def config_map(self):
+        """
+        Gets the config_map of this GenericBmLaunchInstancePlatformConfig.
+        Instance Platform Configuration Configuration Map for flexible setting input.
+
+
+        :return: The config_map of this GenericBmLaunchInstancePlatformConfig.
+        :rtype: dict(str, str)
+        """
+        return self._config_map
+
+    @config_map.setter
+    def config_map(self, config_map):
+        """
+        Sets the config_map of this GenericBmLaunchInstancePlatformConfig.
+        Instance Platform Configuration Configuration Map for flexible setting input.
+
+
+        :param config_map: The config_map of this GenericBmLaunchInstancePlatformConfig.
+        :type: dict(str, str)
+        """
+        self._config_map = config_map
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other