Oracle Cloud Infrastructure Python SDK

https://docs.oracle.com/en-us/iaas/tools/python/latest/
Admin
This is the Python SDK for Oracle Cloud Infrastructure, providing tools and libraries for...
Tokens:17,311,014
Snippets:78,297
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### instructions

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/fleet_apps_management/models/oci.fleet_apps_management.models.SchemaDocument.html

Gets the setup or usage instructions for this stack.

```APIDOC
## instructions

### Description
Gets the instructions of this SchemaDocument. Setup or usage instructions for this stack.

### Returns
- **str** - The instructions of this SchemaDocument.
```

--------------------------------

### InstallationSiteSummary Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.InstallationSiteSummary.html

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

```APIDOC
## InstallationSiteSummary

### Description
Represents a summary of an installation site for Java Runtime.

### Parameters
#### Keyword Arguments
- **installation_key** (str) - The value to assign to the installation_key property of this InstallationSiteSummary.
- **managed_instance_id** (str) - The value to assign to the managed_instance_id property of this InstallationSiteSummary.
- **jre** (oci.jms.models.JavaRuntimeId) - The value to assign to the jre property of this InstallationSiteSummary.
- **security_status** (str) - The value to assign to the security_status property of this InstallationSiteSummary. Allowed values for this property are: "EARLY_ACCESS", "UNKNOWN", "UP_TO_DATE", "UPDATE_REQUIRED", "UPGRADE_REQUIRED", ‘UNKNOWN_ENUM_VALUE’.
- **path** (str) - The value to assign to the path property of this InstallationSiteSummary.
- **operating_system** (oci.jms.models.OperatingSystem) - The value to assign to the operating_system property of this InstallationSiteSummary.
- **approximate_application_count** (int) - The value to assign to the approximate_application_count property of this InstallationSiteSummary.
- **time_last_seen** (datetime) - The value to assign to the time_last_seen property of this InstallationSiteSummary.
- **blocklist** (list[oci.jms.models.BlocklistEntry]) - The value to assign to the blocklist property of this InstallationSiteSummary.
- **lifecycle_state** (str) - The value to assign to the lifecycle_state property of this InstallationSiteSummary. Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "NEEDS_ATTENTION", "UPDATING", ‘UNKNOWN_ENUM_VALUE’.
```

--------------------------------

### Get Budget Processing Period Start Offset

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/budget/models/oci.budget.models.BudgetSummary.html

Retrieves the number of days offset from the first day of the month when the budget processing period starts. For example, a value of 12 means processing starts on the 12th of every month.

```APIDOC
## budget_processing_period_start_offset

### Description
Gets the budget_processing_period_start_offset of this BudgetSummary. The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.

### Returns
- **budget_processing_period_start_offset** (int) - The budget_processing_period_start_offset of this BudgetSummary.
```

--------------------------------

### Example pip 10 Installation Error

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/installation.html

This is an example of a common error message encountered when installing the OCI SDK with pip 10 in a system-wide Python environment, due to conflicts with distutils installed packages.

```bash
sudo pip install oci
...
...
Cannot uninstall 'requests'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall.
```

--------------------------------

### time_last_seen

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.JavaServerUsage.html

Gets the time_last_seen of this JavaServerUsage. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

```APIDOC
## time_last_seen

### Description
Gets the time_last_seen of this JavaServerUsage. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

### Returns
- **datetime**: The time_last_seen of this JavaServerUsage.
```

--------------------------------

### InstallAddonDetails Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/managed_kafka/models/oci.managed_kafka.models.InstallAddonDetails.html

Demonstrates how to initialize an InstallAddonDetails object using keyword arguments for its attributes.

```APIDOC
## __init__ Method

### Description
Initializes a new InstallAddonDetails object with values from keyword arguments.

### Parameters
* **name** (str) - The value to assign to the name property of this InstallAddonDetails.
* **description** (str) - The value to assign to the description property of this InstallAddonDetails.
* **addon_type** (str) - The value to assign to the addon_type property of this InstallAddonDetails.
```

--------------------------------

### __init__ Method

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/lustre_file_storage/models/oci.lustre_file_storage.models.LustreFileSystem.html

Initializes a new LustreFileSystem object with values from keyword arguments.

```APIDOC
## __init__ Method

### Description
Initializes a new LustreFileSystem object with values from keyword arguments.

### Method Signature
`__init__(**kwargs)`
```

--------------------------------

### InstallationSiteSummary.time_last_seen

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.InstallationSiteSummary.html

Gets the time_last_seen of this InstallationSiteSummary. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

```APIDOC
## InstallationSiteSummary.time_last_seen

### Description
Gets the time_last_seen of this InstallationSiteSummary. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

### Returns
- **time_last_seen** (datetime) - The time_last_seen of this InstallationSiteSummary.
```

--------------------------------

### Launch Instance Configuration

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/client/oci.core.ComputeManagementClient.html

Creates an instance from an instance configuration.

```APIDOC
## launch_instance_configuration

### Description
Creates an instance from an instance configuration.

### Method
Not specified in source

### Endpoint
Not specified in source

### Parameters
Not specified in source

### Request Example
Not specified in source

### Response
Not specified in source
```

--------------------------------

### Get Cadence Start Month

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/database/models/oci.database.models.SchedulingPolicySummary.html

Retrieves the starting month for the cadence period of the scheduling policy.

```APIDOC
## cadence_start_month

Gets the cadence_start_month of this SchedulingPolicySummary. Start of the month to be followed during the cadence period.

Returns:
  The cadence_start_month of this SchedulingPolicySummary.

Return type:
  oci.database.models.Month
```

--------------------------------

### ComputeCloudAtCustomerClient Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/compute_cloud_at_customer/client/oci.compute_cloud_at_customer.ComputeCloudAtCustomerClient.html

Demonstrates how to create an instance of the ComputeCloudAtCustomerClient with various configuration options.

```APIDOC
## ComputeCloudAtCustomerClient

`__init__`(_config_ , _**kwargs_)

Creates a new service client.

### Parameters

*   **config** (_dict_) – Configuration keys and values as per SDK and Tool Configuration. The `from_file()` method can be used to load configuration from a file. Alternatively, a `dict` can be passed. You can validate_config the dict using `validate_config()`
*   **service_endpoint** (_str_) – (optional) The endpoint of the service to call using this client. For example `https://iaas.us-ashburn-1.oraclecloud.com`. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
*   **timeout** (_float_ _or_ _tuple_ _(__float_ _,__float_ _)_) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
*   **signer** (`AbstractBaseSigner`) – (optional) The signer to use when signing requests made by the service client. The default is to use a `Signer` based on the values provided in the config parameter. One use case for this parameter is for Instance Principals authentication by passing an instance of `InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument
*   **retry_strategy** (_obj_) – (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a `retry_strategy` keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level. This should be one of the strategies available in the `retry` module. A convenience `DEFAULT_RETRY_STRATEGY` is also available. The specifics of the default retry strategy are described here.
*   **circuit_breaker_strategy** (_obj_) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses `DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
*   **circuit_breaker_callback** (_function_) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
*   **client_level_realm_specific_endpoint_template_enabled** (_bool_) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
*   **allow_control_chars** – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
*   **enable_strict_url_encoding** – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this client should enable strict url encoding in path params of a request. By default, the client will not enable strict url encoding
```

--------------------------------

### Get Time Next Window Starts

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/database/models/oci.database.models.SchedulingPolicySummary.html

Retrieves the timestamp when the next scheduling window is scheduled to start.

```APIDOC
## time_next_window_starts

Gets the time_next_window_starts of this SchedulingPolicySummary. The value to assign to the time_next_window_starts property of this SchedulingPolicySummary.

Returns:
  The time_next_window_starts of this SchedulingPolicySummary.

Return type:
  datetime
```

--------------------------------

### Get Connect Start Time

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/healthchecks/models/oci.healthchecks.models.HttpProbeResultSummary.html

Retrieves the time immediately before the vantage point starts establishing the connection to the server.

```APIDOC
## connect_start

### Description
The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource.

### Method
connect_start

### Return Type
float
```

--------------------------------

### Project Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/devops/models/oci.devops.models.Project.html

Demonstrates how to initialize a Project object.

```APIDOC
## Project Initialization

### Description
Initializes a new Project object with values from keyword arguments.

### Method
`__init__`(**kwargs)

### Parameters
- `**kwargs` - Keyword arguments to initialize the Project object.
```

--------------------------------

### list_installed_patches

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/fleet_apps_management/client/oci.fleet_apps_management.FleetAppsManagementOperationsClient.html

Gets a list of installed patches.

```APIDOC
## list_installed_patches

### Description
Gets a list of installed patches.

### Method
GET

### Endpoint
/20220331/installedPatches

### Parameters
#### Query Parameters
- **compartmentId** (string) - Required - The OCID of the compartment.
- **resourceId** (string) - Optional - Filter by resource OCID.
- **patchId** (string) - Optional - Filter by patch OCID.
- **timeInstalledGreaterThanOrEqualTo** (string) - Optional - Filter by time installed.
- **timeInstalledLessThanOrEqualTo** (string) - Optional - Filter by time installed.
- **limit** (integer) - Optional - The maximum number of items to return.
- **page** (string) - Optional - The pagination token.
- **sortBy** (string) - Optional - The field to sort by. Supported values are `timeInstalled`.
- **sortOrder** (string) - Optional - The sort order. Supported values are `ASC`, `DESC`.

### Response
#### Success Response (200)
- **items** (array) - List of installed patches.
  - **resourceId** (string) - The OCID of the resource.
  - **patchId** (string) - The OCID of the patch.
  - **timeInstalled** (string) - The date and time the patch was installed.
  - **osName** (string) - The operating system name.
  - **osVersion** (string) - The operating system version.
  - **hostName** (string) - The hostname of the resource.
  - **compartmentId** (string) - The OCID of the compartment.
  - **displayName** (string) - The display name of the resource.

#### Response Example
```json
{
  "items": [
    {
      "resourceId": "ocid1.resource.oc1..exampleuniqueID",
      "patchId": "ocid1.patch.oc1..exampleuniqueID",
      "timeInstalled": "2023-01-10T10:00:00Z",
      "osName": "Oracle Linux",
      "osVersion": "8",
      "hostName": "example-host",
      "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
      "displayName": "Example Resource"
    }
  ]
}
```
```

--------------------------------

### InstalledPatchSummary

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/fleet_apps_management/models/oci.fleet_apps_management.models.InstalledPatchSummary.html

Initializes a new InstalledPatchSummary object with values from keyword arguments.

```APIDOC
## InstalledPatchSummary

### Description
Initializes a new InstalledPatchSummary object with values from keyword arguments.

### Method
__init__

### Parameters
#### Keyword Arguments
* **patch_id** (str) - The value to assign to the patch_id property of this InstalledPatchSummary.
* **patch_name** (str) - The value to assign to the patch_name property of this InstalledPatchSummary.
* **patch_description** (str) - The value to assign to the patch_description property of this InstalledPatchSummary.
* **time_applied** (datetime) - The value to assign to the time_applied property of this InstalledPatchSummary.
* **time_released** (datetime) - The value to assign to the time_released property of this InstalledPatchSummary.
* **patch_type** (str) - The value to assign to the patch_type property of this InstalledPatchSummary.
* **patch_level** (str) - The value to assign to the patch_level property of this InstalledPatchSummary.
* **severity** (str) - The value to assign to the severity property of this InstalledPatchSummary. Allowed values for this property are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
```

--------------------------------

### Get Cross-Connect Letter of Authority

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/client/oci.core.VirtualNetworkClient.html

Gets the Letter of Authority for the specified cross-connect. This document is required for physical cross-connect installations.

```APIDOC
## GET /crossConnects/{cross_connect_id}/letterOfAuthority

### Description
Gets the Letter of Authority for the specified cross-connect.

### Method
GET

### Endpoint
/crossConnects/{cross_connect_id}/letterOfAuthority

### Parameters
#### Path Parameters
- **cross_connect_id** (string) - Required - The OCID of the cross-connect.

#### Query Parameters
- **kwargs** (object) - Optional - Additional parameters for the request.
```

--------------------------------

### InstanceConfigurationLaunchOptions

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core.html

Options for tuning the compatibility and performance of VM shapes.

```APIDOC
## oci.core.models.InstanceConfigurationLaunchOptions

### Description
Options for tuning the compatibility and performance of VM shapes.

### Parameters
(No parameters explicitly documented in the source)
```

--------------------------------

### CreateDbSystemSourceDetails

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/mysql.html

Parameters detailing how to provision the initial data of the system.

```APIDOC
## CreateDbSystemSourceDetails

### Description
Parameters detailing how to provision the initial data of the system.

### Model Fields
(No specific fields documented in the source)
```

--------------------------------

### BackupPolicy Window Start Time

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/mysql/models/oci.mysql.models.BackupPolicy.html

Gets the window_start_time of the BackupPolicy. This defines the start of a 30-minute window for daily automated backups.

```APIDOC
## Get BackupPolicy Window Start Time

### Description
Retrieves the start time of the daily backup window for a BackupPolicy. Backups occur within a 30-minute window starting at this time. The system may experience a brief disruption during this window.

### Method
GET

### Endpoint
/backupPolicies/{backupPolicyId}/windowStartTime

### Parameters
#### Path Parameters
- **backupPolicyId** (string) - Required - The OCID of the backup policy.

### Response
#### Success Response (200)
- **window_start_time** (string) - The start time of the backup window in RFC3339 'Time' format (HH:MM:SS). Seconds and sub-seconds are truncated.

#### Response Example
```json
{
  "window_start_time": "03:00:00"
}
```
```

--------------------------------

### Get Domain Lookup Start Time

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/healthchecks/models/oci.healthchecks.models.HttpProbeResultSummary.html

Retrieves the time immediately before the vantage point starts the domain name lookup.

```APIDOC
## domain_lookup_start

### Description
The time immediately before the vantage point starts the domain name lookup for the resource.

### Method
domain_lookup_start

### Return Type
float
```

--------------------------------

### InstallationSite Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.InstallationSite.html

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

```APIDOC
## InstallationSite

### Description
Represents an installation site of a Java Runtime.

### Parameters
#### Keyword Arguments
- **installation_key** (str) - The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system.
- **managed_instance_id** (str) - The OCID of the related managed instance.
- **jre** (oci.jms.models.JavaRuntimeId) - The Java Runtime Identification object.
- **path** (str) - The file system path of the installation.
- **operating_system** (oci.jms.models.OperatingSystem) - The operating system details.
- **approximate_application_count** (int) - The approximate count of applications running on this installation.
- **time_last_seen** (datetime) - The date and time when the installation site was last seen.
- **blocklist** (list[oci.jms.models.BlocklistEntry]) - The list of operations that are blocklisted.
- **lifecycle_state** (str) - The lifecycle state of the installation site. Allowed values: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "NEEDS_ATTENTION", "UPDATING", ‘UNKNOWN_ENUM_VALUE’.
- **managed_instance_type** (str) - The type of the source of events. Allowed values: "ORACLE_MANAGEMENT_AGENT", "ORACLE_CLOUD_AGENT", "ORACLE_CONTAINER_MANAGEMENT_AGENT", ‘UNKNOWN_ENUM_VALUE’.
- **hostname** (str) - The hostname of the managed instance (if applicable).
```

--------------------------------

### current_key_install_count

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/management_agent/models/oci.management_agent.models.ManagementAgentInstallKeySummary.html

Gets the current number of installs for this key.

```APIDOC
## current_key_install_count

### Description
Gets the current number of installs for this key.

### Returns
- **current_key_install_count** (int) - The current number of installs for this key.
```

--------------------------------

### InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/models/oci.core.models.InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails.html

Initializes a new InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails object with values from keyword arguments.

```APIDOC
## InstanceConfigurationIpv6AddressIpv6SubnetCidrPairDetails

### Description
Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses.

### Parameters
#### Keyword Arguments
- **ipv6_subnet_cidr** (str) - Optional. The value to assign to the ipv6_subnet_cidr property.
- **ipv6_address** (str) - Optional. The value to assign to the ipv6_address property.
- **ipv6_id** (str) - Optional. The value to assign to the ipv6_id property.

### Attributes
- **ipv6_address** (str) - Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).
- **ipv6_id** (str) - An OCID that specifies a previously-reserved ipv6 to use.
- **ipv6_subnet_cidr** (str) - Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.
```

--------------------------------

### example_content

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/log_analytics/models/oci.log_analytics.models.TestParserPayloadDetails.html

Gets the example_content of this TestParserPayloadDetails. The example content.

```APIDOC
## example_content

`example_content`¶

### Description
Gets the example_content of this TestParserPayloadDetails. The example content.

### Return Type
str
```

--------------------------------

### InstanceConfigurationLaunchInstanceDetails Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/models/oci.core.models.InstanceConfigurationLaunchInstanceDetails.html

Initializes a new InstanceConfigurationLaunchInstanceDetails object with specified parameters. This constructor accepts various keyword arguments corresponding to the properties of the object.

```APIDOC
## InstanceConfigurationLaunchInstanceDetails

### Description
Initializes a new InstanceConfigurationLaunchInstanceDetails object with values from keyword arguments.

### Method
__init__

### Parameters
#### Keyword Arguments
- **availability_domain** (str) - The value to assign to the availability_domain property of this InstanceConfigurationLaunchInstanceDetails.
- **capacity_reservation_id** (str) - The value to assign to the capacity_reservation_id property of this InstanceConfigurationLaunchInstanceDetails.
- **is_ai_enterprise_enabled** (bool) - The value to assign to the is_ai_enterprise_enabled property of this InstanceConfigurationLaunchInstanceDetails.
- **placement_constraint_details** (oci.core.models.InstanceConfigurationPlacementConstraintDetails) - The value to assign to the placement_constraint_details property of this InstanceConfigurationLaunchInstanceDetails.
- **compute_cluster_id** (str) - The value to assign to the compute_cluster_id property of this InstanceConfigurationLaunchInstanceDetails.
- **compartment_id** (str) - The value to assign to the compartment_id property of this InstanceConfigurationLaunchInstanceDetails.
- **cluster_placement_group_id** (str) - The value to assign to the cluster_placement_group_id property of this InstanceConfigurationLaunchInstanceDetails.
- **create_vnic_details** (oci.core.models.InstanceConfigurationCreateVnicDetails) - The value to assign to the create_vnic_details property of this InstanceConfigurationLaunchInstanceDetails.
- **defined_tags** (dict[str, dict[str, object]]) - The value to assign to the defined_tags property of this InstanceConfigurationLaunchInstanceDetails.
- **security_attributes** (dict[str, dict[str, object]]) - The value to assign to the security_attributes property of this InstanceConfigurationLaunchInstanceDetails.
- **display_name** (str) - The value to assign to the display_name property of this InstanceConfigurationLaunchInstanceDetails.
- **extended_metadata** (dict[str, object]) - The value to assign to the extended_metadata property of this InstanceConfigurationLaunchInstanceDetails.
- **freeform_tags** (dict[str, str]) - The value to assign to the freeform_tags property of this InstanceConfigurationLaunchInstanceDetails.
- **ipxe_script** (str) - The value to assign to the ipxe_script property of this InstanceConfigurationLaunchInstanceDetails.
- **metadata** (dict[str, str]) - The value to assign to the metadata property of this InstanceConfigurationLaunchInstanceDetails.
- **shape** (str) - The value to assign to the shape property of this InstanceConfigurationLaunchInstanceDetails.
- **shape_config** (oci.core.models.InstanceConfigurationLaunchInstanceShapeConfigDetails) - The value to assign to the shape_config property of this InstanceConfigurationLaunchInstanceDetails.
- **platform_config** (oci.core.models.InstanceConfigurationLaunchInstancePlatformConfig) - The value to assign to the platform_config property of this InstanceConfigurationLaunchInstanceDetails.
- **source_details** (oci.core.models.InstanceConfigurationInstanceSourceDetails) - The value to assign to the source_details property of this InstanceConfigurationLaunchInstanceDetails.
```

--------------------------------

### InstanceConfigurationLaunchInstanceAgentConfigDetails

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/models/oci.core.models.InstanceConfigurationLaunchInstanceAgentConfigDetails.html

Initializes a new InstanceConfigurationLaunchInstanceAgentConfigDetails object with values from keyword arguments.

```APIDOC
## Class: InstanceConfigurationLaunchInstanceAgentConfigDetails

### Description
Configuration options for the Oracle Cloud Agent software running on the instance.

### Methods
#### `__init__`(**kwargs)
Initializes a new InstanceConfigurationLaunchInstanceAgentConfigDetails object with values from keyword arguments.

Parameters:
- **is_monitoring_disabled** (bool) - The value to assign to the is_monitoring_disabled property of this InstanceConfigurationLaunchInstanceAgentConfigDetails.
- **is_management_disabled** (bool) - The value to assign to the is_management_disabled property of this InstanceConfigurationLaunchInstanceAgentConfigDetails.
- **are_all_plugins_disabled** (bool) - The value to assign to the are_all_plugins_disabled property of this InstanceConfigurationLaunchInstanceAgentConfigDetails.
- **plugins_config** (list[oci.core.models.InstanceAgentPluginConfigDetails]) - The value to assign to the plugins_config property of this InstanceConfigurationLaunchInstanceAgentConfigDetails.

### Attributes
#### `are_all_plugins_disabled`
Gets the are_all_plugins_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails. Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

Returns:
- bool: The are_all_plugins_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails.

#### `is_management_disabled`
Gets the is_management_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails. Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

Returns:
- bool: The is_management_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails.

#### `is_monitoring_disabled`
Gets the is_monitoring_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails. Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

Returns:
- bool: The is_monitoring_disabled of this InstanceConfigurationLaunchInstanceAgentConfigDetails.

#### `plugins_config`
Gets the plugins_config of this InstanceConfigurationLaunchInstanceAgentConfigDetails. The configuration of plugins associated with this instance.

Returns:
- list[oci.core.models.InstanceAgentPluginConfigDetails]: The plugins_config of this InstanceConfigurationLaunchInstanceAgentConfigDetails.
```

--------------------------------

### Get Estimated Component Patching Start Time

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/database/models/oci.database.models.MaintenanceRunSummary.html

Retrieves the estimated start time for the next infrastructure component patching operation.

```APIDOC
## estimated_component_patching_start_time

### Description
Gets the estimated_component_patching_start_time of this MaintenanceRunSummary. The estimated start time of the next infrastruture component patching operation.

### Returns
The estimated_component_patching_start_time of this MaintenanceRunSummary.

### Return type
datetime
```

--------------------------------

### PostInstallationActionSettings Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.PostInstallationActionSettings.html

Initializes a new PostInstallationActionSettings object with values from keyword arguments. This allows for setting various post-installation configurations.

```APIDOC
## PostInstallationActionSettings

`__init__`(_**kwargs_)

Initializes a new PostInstallationActionSettings object with values from keyword arguments. The following keyword arguments are supported:

* **disabled_tls_versions** (_list_[_oci.jms.models.TlsVersions_]_): The value to assign to the disabled_tls_versions property.
* **should_replace_certificates_operating_system** (_bool_): The value to assign to the should_replace_certificates_operating_system property.
* **minimum_key_size_settings** (_oci.jms.models.MinimumKeySizeSettings_): The value to assign to the minimum_key_size_settings property.
* **add_logging_handler** (_bool_): The value to assign to the add_logging_handler property.
* **global_logging_level** (_str_): The value to assign to the global_logging_level property. Allowed values: "ALL", "SEVERE", "WARNING", "INFO", "CONFIG", "FINE", "FINER", "FINEST", "OFF", ‘UNKNOWN_ENUM_VALUE’.
* **proxies** (_oci.jms.models.Proxies_): The value to assign to the proxies property.
```

--------------------------------

### Folder Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/data_catalog/models/oci.data_catalog.models.Folder.html

Demonstrates how to initialize a new Folder object using keyword arguments.

```APIDOC
## Folder Initialization

### Description
Initializes a new Folder object with values provided as keyword arguments.

### Method
`__init__`(**kwargs)

### Parameters
- **kwargs** (dict) - Keyword arguments to initialize the Folder object.
```

--------------------------------

### list_wls_domain_server_installed_patches

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/wlms/client/oci.wlms.WeblogicManagementServiceClient.html

Gets a list of installed patches on a server for a domain.

```APIDOC
## list_wls_domain_server_installed_patches

### Description
Gets a list of installed patches on a server for a domain.

### Method
list_wls_domain_server_installed_patches

### Parameters
- **wls_domain_id** (string) - Required - The OCID of the WebLogic domain.
- **wls_server_id** (string) - Required - The OCID of the WebLogic server.
- **opc_request_id** (string) - Optional - Unique identifier for the request.

### Response
#### Success Response (200)
- **items** (array[PatchSummary]) - A list of installed patches.
```

--------------------------------

### list_applicable_patches

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/wlms/client/oci.wlms.WeblogicManagementServiceClient.html

Gets the latest patches that can be installed to the WebLogic domains.

```APIDOC
## list_applicable_patches

### Description
Gets the latest patches that can be installed to the WebLogic domains.

### Method
list_applicable_patches

### Parameters
- **wls_domain_id** (string) - Required - The OCID of the WebLogic domain.
- **opc_request_id** (string) - Optional - Unique identifier for the request.

### Response
#### Success Response (200)
- **items** (array[PatchSummary]) - A list of applicable patches.
```

--------------------------------

### DatabaseToolsKeyStorePostgresqlDetails Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/database_tools/models/oci.database_tools.models.DatabaseToolsKeyStorePostgresqlDetails.html

Initializes a new DatabaseToolsKeyStorePostgresqlDetails object with specified key store details.

```APIDOC
## DatabaseToolsKeyStorePostgresqlDetails

### Description
Represents the details of a PostgreSQL key store.

### Method
__init__

### Parameters
#### Keyword Arguments
- **key_store_type** (str) - Required - The type of the key store. Allowed values: "CLIENT_CERTIFICATE_PEM", "CLIENT_PRIVATE_KEY_PEM", "CA_CERTIFICATE_PEM".
- **key_store_content** (oci.database_tools.models.DatabaseToolsKeyStoreContentPostgresqlDetails) - Required - The content of the key store.
- **key_store_password** (oci.database_tools.models.DatabaseToolsKeyStorePasswordPostgresqlDetails) - Required - The password for the key store.

### Attributes
- **KEY_STORE_TYPE_CA_CERTIFICATE_PEM** (str) - Constant for CA_CERTIFICATE_PEM key store type.
- **KEY_STORE_TYPE_CLIENT_CERTIFICATE_PEM** (str) - Constant for CLIENT_CERTIFICATE_PEM key store type.
- **KEY_STORE_TYPE_CLIENT_PRIVATE_KEY_PEM** (str) - Constant for CLIENT_PRIVATE_KEY_PEM key store type.
- **key_store_content** (oci.database_tools.models.DatabaseToolsKeyStoreContentPostgresqlDetails) - The content of the key store.
- **key_store_password** (oci.database_tools.models.DatabaseToolsKeyStorePasswordPostgresqlDetails) - The password for the key store.
- **key_store_type** (str) - The type of the key store. Allowed values: "CLIENT_CERTIFICATE_PEM", "CLIENT_PRIVATE_KEY_PEM", "CA_CERTIFICATE_PEM"
```

--------------------------------

### id

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/management_agent/models/oci.management_agent.models.ManagementAgentInstallKeySummary.html

Gets the identifier of the Management Agent Install Key.

```APIDOC
## id

### Description
Gets the identifier of the Management Agent Install Key.

### Parameters
This property is required.

### Returns
- **id** (str) - The identifier of the Management Agent Install Key.
```

--------------------------------

### InstanceConfigurationLaunchOptions

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/core/models/oci.core.models.InstanceConfigurationLaunchOptions.html

Provides details about the launch options for an instance configuration, including settings for consistent volume naming, network emulation, and remote data volume types.

```APIDOC
## InstanceConfigurationLaunchOptions

This class provides configuration options for launching instances.

### Attributes

*   **is_consistent_volume_naming_enabled** (bool) - Whether to enable consistent volume naming feature. Defaults to false.
*   **is_pv_encryption_in_transit_enabled** (bool) - Deprecated. Instead use isPvEncryptionInTransitEnabled in `instance_configuration_launch_instance_details()`.
*   **network_type** (str) - Emulation type for the physical network interface card (NIC).
    Allowed values: "E1000", "VFIO", "PARAVIRTUALIZED", "ACCELERATEDPV", ‘UNKNOWN_ENUM_VALUE’.
*   **remote_data_volume_type** (str) - Emulation type for volume.
    Allowed values: "ISCSI", "SCSI", "IDE", "VFIO", "PARAVIRTUALIZED", ‘UNKNOWN_ENUM_VALUE’.
```

--------------------------------

### InstallationUsageCollection

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.InstallationUsageCollection.html

Initializes a new InstallationUsageCollection object. This class holds a list of installation usages.

```APIDOC
## InstallationUsageCollection

### Description
Represents the results of an installation search. Contains InstallationUsage items.

### Method
__init__

### Parameters
#### Keyword Arguments
- **items** (list[oci.jms.models.InstallationUsage]) - Required - The value to assign to the items property of this InstallationUsageCollection.

### Attributes
- **items** (list[oci.jms.models.InstallationUsage]) - Required - Gets the items of this InstallationUsageCollection. A list of installations.
```

--------------------------------

### allowed_key_install_count

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/management_agent/models/oci.management_agent.models.ManagementAgentInstallKeySummary.html

Gets the total number of installs allowed for this key.

```APIDOC
## allowed_key_install_count

### Description
Gets the total number of installs allowed for this key.

### Returns
- **allowed_key_install_count** (int) - The allowed number of installs for this key.
```

--------------------------------

### ImageJob.time_started

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/ai_vision/models/oci.ai_vision.models.ImageJob.html

Gets the time_started of this ImageJob. The job start time.

```APIDOC
## ImageJob.time_started

### Description
Gets the time_started of this ImageJob. The job start time.

### Returns
- **datetime**: The time_started of this ImageJob.
```

--------------------------------

### CreateDbHomeForStandbyDbSystem Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/database/models/oci.database.models.CreateDbHomeForStandbyDbSystem.html

Demonstrates how to initialize a CreateDbHomeForStandbyDbSystem object using keyword arguments.

```APIDOC
## Method: __init__

### Description
Initializes a new CreateDbHomeForStandbyDbSystem object with values from keyword arguments.

### Parameters
* **display_name** (str) - Optional - The value to assign to the display_name property of this CreateDbHomeForStandbyDbSystem.
* **database** (oci.database.models.CreateDatabaseForStandbyDbSystemDetails) - Required - The value to assign to the database property of this CreateDbHomeForStandbyDbSystem.
```

--------------------------------

### NewInstallationSite Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/jms/models/oci.jms.models.NewInstallationSite.html

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

```APIDOC
## NewInstallationSite Initialization

### Description
Initializes a new NewInstallationSite object with values from keyword arguments.

### Parameters
#### Keyword Arguments
- **managed_instance_id** (str) - Required - The OCID of the related managed instance.
- **release_version** (str) - Required - The release version of the Java Runtime.
- **artifact_content_type** (str) - Optional - Artifact content type for the Java version. Allowed values: "JDK", "JRE", "SERVER_JRE", ‘UNKNOWN_ENUM_VALUE’.
- **installation_path** (str) - Optional - Custom path to install new Java installation site.
- **headless_mode** (bool) - Optional - Flag to install headless or headful Java installation. Only valid for Oracle Linux in OCI.
- **force_install** (bool) - Optional - Forces the installation request even if a more recent release is already present in the host.
```

--------------------------------

### Get Window Start Time

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/mysql/models/oci.mysql.models.MaintenanceDetails.html

Retrieves the start time of the maintenance window for a MaintenanceDetails object. The format is "{day-of-week} {time-of-day}".

```APIDOC
## Get Maintenance Window Start Time

### Description
Gets the `window_start_time` of this MaintenanceDetails. The start time of the maintenance window.
This string is of the format: “{day-of-week} {time-of-day}”.
“{day-of-week}” is a case-insensitive string like “mon”, “tue”, &c.
“{time-of-day}” is the “Time” portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.

### Method
GET (assumed, as it's a getter method)

### Endpoint
`/MaintenanceDetails/{id}/window_start_time` (assumed, based on typical RESTful getter patterns)

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the MaintenanceDetails object.

### Response
#### Success Response (200)
- **window_start_time** (str) - The start time of the maintenance window.
```

--------------------------------

### list_managed_instance_server_installed_patches

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/wlms/client/oci.wlms.WeblogicManagementServiceClient.html

Gets a list of installed patches on a server in a managed instance.

```APIDOC
## list_managed_instance_server_installed_patches

### Description
Gets a list of installed patches on a server in a managed instance.

### Method
list_managed_instance_server_installed_patches

### Parameters
- **managed_instance_id** (string) - Required - The OCID of the managed instance.
- **wls_server_id** (string) - Required - The OCID of the WebLogic server.
- **opc_request_id** (string) - Optional - Unique identifier for the request.

### Response
#### Success Response (200)
- **items** (array[PatchSummary]) - A list of installed patches.
```

--------------------------------

### CreateLustreFileSystemDetails Initialization

Source: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/lustre_file_storage/models/oci.lustre_file_storage.models.CreateLustreFileSystemDetails.html

Initializes a new CreateLustreFileSystemDetails object with values from keyword arguments.

```APIDOC
## CreateLustreFileSystemDetails

### Description
Represents the details required to create a Lustre file system.

### Parameters
#### Keyword Arguments
- **availability_domain** (string) - Required - The availability domain to create the file system in.
- **capacity_in_gbs** (string) - Required - The capacity of the file system in GBs.
- **compartment_id** (string) - Required - The OCID of the compartment to create the file system in.
- **file_system_name** (string) - Required - The name of the file system.
- **performance_tier** (string) - Required - The performance tier of the file system. Use constants like `PERFORMANCE_TIER_MBPS_PER_TB_1000`.
- **root_squash_configuration** (string) - Required - The root squash configuration for the file system.
- **subnet_id** (string) - Required - The OCID of the subnet to create the file system in.
- **cluster_placement_group_id** (string) - Optional - The OCID of the cluster placement group to create the file system in.
- **defined_tags** (object) - Optional - Defined tags for the file system.
- **display_name** (string) - Optional - A user-friendly name for the file system.
- **file_system_description** (string) - Optional - A description for the file system.
- **freeform_tags** (object) - Optional - Free-form tags for the file system.
- **kms_key_id** (string) - Optional - The OCID of the KMS key to use for encryption.
- **maintenance_window** (object) - Optional - The maintenance window for the file system.
- **nsg_ids** (array) - Optional - A list of network security group OCIDs to associate with the file system.

### Constants for performance_tier
- **PERFORMANCE_TIER_MBPS_PER_TB_1000** (string) - Represents 1000 MBPS per TB.
- **PERFORMANCE_TIER_MBPS_PER_TB_125** (string) - Represents 125 MBPS per TB.
- **PERFORMANCE_TIER_MBPS_PER_TB_250** (string) - Represents 250 MBPS per TB.
- **PERFORMANCE_TIER_MBPS_PER_TB_500** (string) - Represents 500 MBPS per TB.

### Example
```python
{
  "availability_domain": "AD-1",
  "capacity_in_gbs": "1024",
  "compartment_id": "ocid1.compartment.oc1..exampleuniqueID",
  "file_system_name": "my-lustre-fs",
  "performance_tier": "MBPS_PER_TB_1000",
  "root_squash_configuration": "ROOTSQUASH",
  "subnet_id": "ocid1.subnet.oc1.iad.exampleuniqueID"
}
```
```
Tokens:
Raw