ActionTypesEnum Enum with underlying type: string
type ActionTypesEnum string
Set of constants representing the allowable values for ActionTypesEnum
const ( ActionTypesCreated ActionTypesEnum = "CREATED" ActionTypesUpdated ActionTypesEnum = "UPDATED" ActionTypesDeleted ActionTypesEnum = "DELETED" ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS" ActionTypesRelated ActionTypesEnum = "RELATED" )
func GetActionTypesEnumValues() []ActionTypesEnum
GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum
ChangeSddcCompartmentDetails The configuration details for the move operation.
type ChangeSddcCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move // the SDDC to. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeSddcCompartmentDetails) String() string
ChangeSddcCompartmentRequest wrapper for the ChangeSddcCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartmentRequest.
type ChangeSddcCompartmentRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"` // Request to change the compartment of the specified SDDC ChangeSddcCompartmentDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations (for example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeSddcCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSddcCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSddcCompartmentRequest) String() string
ChangeSddcCompartmentResponse wrapper for the ChangeSddcCompartment operation
type ChangeSddcCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeSddcCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSddcCompartmentResponse) String() string
CreateEsxiHostDetails Details of the ESXi host to add to the SDDC.
type CreateEsxiHostDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC to add the // ESXi host to. SddcId *string `mandatory:"true" json:"sddcId"` // A descriptive name for the ESXi host. It's changeable. // Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the SDDC. // If this attribute is not specified, the SDDC's `instanceDisplayNamePrefix` attribute is used // to name and incrementally number the ESXi host. For example, if you're creating the fourth // ESXi host in the SDDC, and `instanceDisplayNamePrefix` is `MySDDC`, the host's display // name is `MySDDC-4`. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateEsxiHostDetails) String() string
CreateEsxiHostRequest wrapper for the CreateEsxiHost operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateEsxiHost.go.html to see an example of how to use CreateEsxiHostRequest.
type CreateEsxiHostRequest struct { // Details for the ESXi host. CreateEsxiHostDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations (for example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEsxiHostRequest) String() string
CreateEsxiHostResponse wrapper for the CreateEsxiHost operation
type CreateEsxiHostResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEsxiHostResponse) String() string
CreateSddcDetails Details of the SDDC.
type CreateSddcDetails struct { // The availability domain to create the SDDC's ESXi hosts in. ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"` // The VMware software bundle to install on the ESXi hosts in the SDDC. To get a // list of the available versions, use // ListSupportedVmwareSoftwareVersions. VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The number of ESXi hosts to create in the SDDC. You can add more hosts later // (see CreateEsxiHost). // **Note:** If you later delete EXSi hosts from the SDDC to total less than 3, // you are still billed for the 3 minimum recommended EXSi hosts. Also, // you cannot add more VMware workloads to the SDDC until it again has at least // 3 ESXi hosts. EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"` // One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for // the default user on each ESXi host. Use a newline character to separate multiple keys. // The SSH keys must be in the format required for the `authorized_keys` file SshAuthorizedKeys *string `mandatory:"true" json:"sshAuthorizedKeys"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management subnet to use // for provisioning the SDDC. ProvisioningSubnetId *string `mandatory:"true" json:"provisioningSubnetId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSphere // component of the VMware environment. VsphereVlanId *string `mandatory:"true" json:"vsphereVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vMotion // component of the VMware environment. VmotionVlanId *string `mandatory:"true" json:"vmotionVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the vSAN // component of the VMware environment. VsanVlanId *string `mandatory:"true" json:"vsanVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX VTEP // component of the VMware environment. NsxVTepVlanId *string `mandatory:"true" json:"nsxVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge VTEP // component of the VMware environment. NsxEdgeVTepVlanId *string `mandatory:"true" json:"nsxEdgeVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge // Uplink 1 component of the VMware environment. NsxEdgeUplink1VlanId *string `mandatory:"true" json:"nsxEdgeUplink1VlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for the NSX Edge // Uplink 2 component of the VMware environment. NsxEdgeUplink2VlanId *string `mandatory:"true" json:"nsxEdgeUplink2VlanId"` // A descriptive name for the SDDC. // SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // A prefix used in the name of each ESXi host and Compute instance in the SDDC. // If this isn't set, the SDDC's `displayName` is used as the prefix. // For example, if the value is `mySDDC`, the ESXi hosts are named `mySDDC-1`, // `mySDDC-2`, and so on. InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"` // This flag tells us if HCX is enabled or not. IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"` // This id is required only when hcxEnabled is true HcxVlanId *string `mandatory:"false" json:"hcxVlanId"` // The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application // workloads. WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateSddcDetails) String() string
CreateSddcRequest wrapper for the CreateSddc operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateSddc.go.html to see an example of how to use CreateSddcRequest.
type CreateSddcRequest struct { // Details for the SDDC. CreateSddcDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing that same action again. Retry tokens expire after 24 // hours, but can be invalidated before then due to conflicting operations (for example, if a resource // has been deleted and purged from the system, then a retry of the original creation request // may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateSddcRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSddcRequest) String() string
CreateSddcResponse wrapper for the CreateSddc operation
type CreateSddcResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSddcResponse) String() string
DeleteEsxiHostRequest wrapper for the DeleteEsxiHost operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHostRequest.
type DeleteEsxiHostRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host. EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEsxiHostRequest) String() string
DeleteEsxiHostResponse wrapper for the DeleteEsxiHost operation
type DeleteEsxiHostResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEsxiHostResponse) String() string
DeleteSddcRequest wrapper for the DeleteSddc operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddcRequest.
type DeleteSddcRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteSddcRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSddcRequest) String() string
DeleteSddcResponse wrapper for the DeleteSddc operation
type DeleteSddcResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSddcResponse) String() string
EsxiHost An ESXi host is a node in an SDDC. At a minimum, each SDDC has 3 ESXi hosts that are used to implement a functioning VMware environment. In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Notice that an `EsxiHost` object has its own OCID (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`).
type EsxiHost struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host. Id *string `mandatory:"true" json:"id"` // A descriptive name for the ESXi host. Does not have to be unique, and it's changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC that the // ESXi host belongs to. SddcId *string `mandatory:"true" json:"sddcId"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"true" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the SDDC. CompartmentId *string `mandatory:"false" json:"compartmentId"` // In terms of implementation, an ESXi host is a Compute instance that // is configured with the chosen bundle of VMware software. The `computeInstanceId` // is the OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of that Compute instance. ComputeInstanceId *string `mandatory:"false" json:"computeInstanceId"` // The date and time the ESXi host was created, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). // Example: `2016-08-25T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The date and time the ESXi host was updated, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current state of the ESXi host. LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m EsxiHost) String() string
EsxiHostClient a client for EsxiHost
type EsxiHostClient struct { common.BaseClient // contains filtered or unexported fields }
func NewEsxiHostClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EsxiHostClient, err error)
NewEsxiHostClientWithConfigurationProvider Creates a new default EsxiHost client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewEsxiHostClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EsxiHostClient, err error)
NewEsxiHostClientWithOboToken Creates a new default EsxiHost client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *EsxiHostClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EsxiHostClient) CreateEsxiHost(ctx context.Context, request CreateEsxiHostRequest) (response CreateEsxiHostResponse, err error)
CreateEsxiHost Adds another ESXi host to an existing SDDC. The attributes of the specified `Sddc` determine the VMware software and other configuration settings used by the ESXi host. Use the WorkRequest operations to track the creation of the ESXi host.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateEsxiHost.go.html to see an example of how to use CreateEsxiHost API.
func (client EsxiHostClient) DeleteEsxiHost(ctx context.Context, request DeleteEsxiHostRequest) (response DeleteEsxiHostResponse, err error)
DeleteEsxiHost Deletes the specified ESXi host. Before deleting the host, back up or migrate any VMware workloads running on it. When you delete an ESXi host, Oracle does not remove the node configuration within the VMware environment itself. That is your responsibility. **Note:** If you delete EXSi hosts from the SDDC to total less than 3, you are still billed for the 3 minimum recommended EXSi hosts. Also, you cannot add more VMware workloads to the SDDC until it again has at least 3 ESXi hosts. Use the WorkRequest operations to track the deletion of the ESXi host.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteEsxiHost.go.html to see an example of how to use DeleteEsxiHost API.
func (client EsxiHostClient) GetEsxiHost(ctx context.Context, request GetEsxiHostRequest) (response GetEsxiHostResponse, err error)
GetEsxiHost Gets the specified ESXi host's information.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHost API.
func (client EsxiHostClient) ListEsxiHosts(ctx context.Context, request ListEsxiHostsRequest) (response ListEsxiHostsResponse, err error)
ListEsxiHosts Lists the ESXi hosts in the specified SDDC. The list can be filtered by Compute instance OCID or ESXi display name. Remember that in terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software. Each `EsxiHost` object has its own OCID (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`). When filtering the list of ESXi hosts, you can specify the OCID of the Compute instance, not the ESXi host OCID.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHosts API.
func (client *EsxiHostClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client EsxiHostClient) UpdateEsxiHost(ctx context.Context, request UpdateEsxiHostRequest) (response UpdateEsxiHostResponse, err error)
UpdateEsxiHost Updates the specified ESXi host.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHost API.
EsxiHostCollection A list of ESXi hosts.
type EsxiHostCollection struct { // A list of ESXi hosts. Items []EsxiHostSummary `mandatory:"true" json:"items"` }
func (m EsxiHostCollection) String() string
EsxiHostSummary A summary of the ESXi host.
type EsxiHostSummary struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host. Id *string `mandatory:"true" json:"id"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC that the // ESXi host belongs to. SddcId *string `mandatory:"true" json:"sddcId"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"true" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"` // A descriptive name for the ESXi host. Does not have to be unique, and it's changeable. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the SDDC. CompartmentId *string `mandatory:"false" json:"compartmentId"` // In terms of implementation, an ESXi host is a Compute instance that // is configured with the chosen bundle of VMware software. The `computeInstanceId` // is the OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of that Compute instance. ComputeInstanceId *string `mandatory:"false" json:"computeInstanceId"` // The date and time the ESXi host was created, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). // Example: `2016-08-25T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The date and time the ESXi host was updated, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current state of the ESXi host. LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m EsxiHostSummary) String() string
GetEsxiHostRequest wrapper for the GetEsxiHost operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetEsxiHost.go.html to see an example of how to use GetEsxiHostRequest.
type GetEsxiHostRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host. EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEsxiHostRequest) String() string
GetEsxiHostResponse wrapper for the GetEsxiHost operation
type GetEsxiHostResponse struct { // The underlying http response RawResponse *http.Response // The EsxiHost instance EsxiHost `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEsxiHostResponse) String() string
GetSddcRequest wrapper for the GetSddc operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetSddc.go.html to see an example of how to use GetSddcRequest.
type GetSddcRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetSddcRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSddcRequest) String() string
GetSddcResponse wrapper for the GetSddc operation
type GetSddcResponse struct { // The underlying http response RawResponse *http.Response // The Sddc instance Sddc `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSddcResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct { // The underlying http response RawResponse *http.Response // The WorkRequest instance WorkRequest `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // A decimal number representing the number of seconds the client should wait before polling this endpoint again. RetryAfter *float32 `presentIn:"header" name:"retry-after"` }
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum
const ( LifecycleStatesCreating LifecycleStatesEnum = "CREATING" LifecycleStatesUpdating LifecycleStatesEnum = "UPDATING" LifecycleStatesActive LifecycleStatesEnum = "ACTIVE" LifecycleStatesDeleting LifecycleStatesEnum = "DELETING" LifecycleStatesDeleted LifecycleStatesEnum = "DELETED" LifecycleStatesFailed LifecycleStatesEnum = "FAILED" )
func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum
ListEsxiHostsLifecycleStateEnum Enum with underlying type: string
type ListEsxiHostsLifecycleStateEnum string
Set of constants representing the allowable values for ListEsxiHostsLifecycleStateEnum
const ( ListEsxiHostsLifecycleStateCreating ListEsxiHostsLifecycleStateEnum = "CREATING" ListEsxiHostsLifecycleStateUpdating ListEsxiHostsLifecycleStateEnum = "UPDATING" ListEsxiHostsLifecycleStateActive ListEsxiHostsLifecycleStateEnum = "ACTIVE" ListEsxiHostsLifecycleStateDeleting ListEsxiHostsLifecycleStateEnum = "DELETING" ListEsxiHostsLifecycleStateDeleted ListEsxiHostsLifecycleStateEnum = "DELETED" ListEsxiHostsLifecycleStateFailed ListEsxiHostsLifecycleStateEnum = "FAILED" )
func GetListEsxiHostsLifecycleStateEnumValues() []ListEsxiHostsLifecycleStateEnum
GetListEsxiHostsLifecycleStateEnumValues Enumerates the set of values for ListEsxiHostsLifecycleStateEnum
ListEsxiHostsRequest wrapper for the ListEsxiHosts operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListEsxiHosts.go.html to see an example of how to use ListEsxiHostsRequest.
type ListEsxiHostsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. SddcId *string `mandatory:"false" contributesTo:"query" name:"sddcId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Compute instance. ComputeInstanceId *string `mandatory:"false" contributesTo:"query" name:"computeInstanceId"` // A filter to return only resources that match the given display name exactly. DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order // is case sensitive. SortOrder ListEsxiHostsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to sort by. You can provide one sort order (`sortOrder`). Default order for // TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME // sort order is case sensitive. // **Note:** In general, some "List" operations (for example, `ListInstances`) let you // optionally filter by availability domain if the scope of the resource type is within a // single availability domain. If you call one of these "List" operations without specifying // an availability domain, the resources are grouped by availability domain, then sorted. SortBy ListEsxiHostsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The lifecycle state of the resource. LifecycleState ListEsxiHostsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListEsxiHostsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEsxiHostsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEsxiHostsRequest) String() string
ListEsxiHostsResponse wrapper for the ListEsxiHosts operation
type ListEsxiHostsResponse struct { // The underlying http response RawResponse *http.Response // A list of EsxiHostCollection instances EsxiHostCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListEsxiHostsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEsxiHostsResponse) String() string
ListEsxiHostsSortByEnum Enum with underlying type: string
type ListEsxiHostsSortByEnum string
Set of constants representing the allowable values for ListEsxiHostsSortByEnum
const ( ListEsxiHostsSortByTimecreated ListEsxiHostsSortByEnum = "timeCreated" ListEsxiHostsSortByDisplayname ListEsxiHostsSortByEnum = "displayName" )
func GetListEsxiHostsSortByEnumValues() []ListEsxiHostsSortByEnum
GetListEsxiHostsSortByEnumValues Enumerates the set of values for ListEsxiHostsSortByEnum
ListEsxiHostsSortOrderEnum Enum with underlying type: string
type ListEsxiHostsSortOrderEnum string
Set of constants representing the allowable values for ListEsxiHostsSortOrderEnum
const ( ListEsxiHostsSortOrderAsc ListEsxiHostsSortOrderEnum = "ASC" ListEsxiHostsSortOrderDesc ListEsxiHostsSortOrderEnum = "DESC" )
func GetListEsxiHostsSortOrderEnumValues() []ListEsxiHostsSortOrderEnum
GetListEsxiHostsSortOrderEnumValues Enumerates the set of values for ListEsxiHostsSortOrderEnum
ListSddcsLifecycleStateEnum Enum with underlying type: string
type ListSddcsLifecycleStateEnum string
Set of constants representing the allowable values for ListSddcsLifecycleStateEnum
const ( ListSddcsLifecycleStateCreating ListSddcsLifecycleStateEnum = "CREATING" ListSddcsLifecycleStateUpdating ListSddcsLifecycleStateEnum = "UPDATING" ListSddcsLifecycleStateActive ListSddcsLifecycleStateEnum = "ACTIVE" ListSddcsLifecycleStateDeleting ListSddcsLifecycleStateEnum = "DELETING" ListSddcsLifecycleStateDeleted ListSddcsLifecycleStateEnum = "DELETED" ListSddcsLifecycleStateFailed ListSddcsLifecycleStateEnum = "FAILED" )
func GetListSddcsLifecycleStateEnumValues() []ListSddcsLifecycleStateEnum
GetListSddcsLifecycleStateEnumValues Enumerates the set of values for ListSddcsLifecycleStateEnum
ListSddcsRequest wrapper for the ListSddcs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSddcs.go.html to see an example of how to use ListSddcsRequest.
type ListSddcsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The name of the availability domain that the Compute instances are running in. // Example: `Uocm:PHX-AD-1` ComputeAvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"computeAvailabilityDomain"` // A filter to return only resources that match the given display name exactly. DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order // is case sensitive. SortOrder ListSddcsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The field to sort by. You can provide one sort order (`sortOrder`). Default order for // TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME // sort order is case sensitive. // **Note:** In general, some "List" operations (for example, `ListInstances`) let you // optionally filter by availability domain if the scope of the resource type is within a // single availability domain. If you call one of these "List" operations without specifying // an availability domain, the resources are grouped by availability domain, then sorted. SortBy ListSddcsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The lifecycle state of the resource. LifecycleState ListSddcsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListSddcsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSddcsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSddcsRequest) String() string
ListSddcsResponse wrapper for the ListSddcs operation
type ListSddcsResponse struct { // The underlying http response RawResponse *http.Response // A list of SddcCollection instances SddcCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListSddcsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSddcsResponse) String() string
ListSddcsSortByEnum Enum with underlying type: string
type ListSddcsSortByEnum string
Set of constants representing the allowable values for ListSddcsSortByEnum
const ( ListSddcsSortByTimecreated ListSddcsSortByEnum = "timeCreated" ListSddcsSortByDisplayname ListSddcsSortByEnum = "displayName" )
func GetListSddcsSortByEnumValues() []ListSddcsSortByEnum
GetListSddcsSortByEnumValues Enumerates the set of values for ListSddcsSortByEnum
ListSddcsSortOrderEnum Enum with underlying type: string
type ListSddcsSortOrderEnum string
Set of constants representing the allowable values for ListSddcsSortOrderEnum
const ( ListSddcsSortOrderAsc ListSddcsSortOrderEnum = "ASC" ListSddcsSortOrderDesc ListSddcsSortOrderEnum = "DESC" )
func GetListSddcsSortOrderEnumValues() []ListSddcsSortOrderEnum
GetListSddcsSortOrderEnumValues Enumerates the set of values for ListSddcsSortOrderEnum
ListSupportedVmwareSoftwareVersionsRequest wrapper for the ListSupportedVmwareSoftwareVersions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersionsRequest.
type ListSupportedVmwareSoftwareVersionsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListSupportedVmwareSoftwareVersionsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSupportedVmwareSoftwareVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSupportedVmwareSoftwareVersionsRequest) String() string
ListSupportedVmwareSoftwareVersionsResponse wrapper for the ListSupportedVmwareSoftwareVersions operation
type ListSupportedVmwareSoftwareVersionsResponse struct { // The underlying http response RawResponse *http.Response // A list of SupportedVmwareSoftwareVersionCollection instances SupportedVmwareSoftwareVersionCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListSupportedVmwareSoftwareVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSupportedVmwareSoftwareVersionsResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct { // The underlying http response RawResponse *http.Response // A list of WorkRequestErrorCollection instances WorkRequestErrorCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct { // The underlying http response RawResponse *http.Response // A list of WorkRequestLogEntryCollection instances WorkRequestLogEntryCollection `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource. ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For list pagination. The value of the `opc-next-page` response header from the previous "List" // call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // For list pagination. The maximum number of results per page, or items to return in a paginated // "List" call. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct { // The underlying http response RawResponse *http.Response // A list of WorkRequestCollection instances WorkRequestCollection `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` // For list pagination. When this header appears in the response, additional pages // of results remain. For important details about how pagination works, see // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` }
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const ( OperationStatusAccepted OperationStatusEnum = "ACCEPTED" OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS" OperationStatusFailed OperationStatusEnum = "FAILED" OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED" OperationStatusCanceling OperationStatusEnum = "CANCELING" OperationStatusCanceled OperationStatusEnum = "CANCELED" )
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypesEnum Enum with underlying type: string
type OperationTypesEnum string
Set of constants representing the allowable values for OperationTypesEnum
const ( OperationTypesCreateSddc OperationTypesEnum = "CREATE_SDDC" OperationTypesDeleteSddc OperationTypesEnum = "DELETE_SDDC" OperationTypesCreateEsxiHost OperationTypesEnum = "CREATE_ESXI_HOST" OperationTypesDeleteEsxiHost OperationTypesEnum = "DELETE_ESXI_HOST" )
func GetOperationTypesEnumValues() []OperationTypesEnum
GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum
Sddc A software-defined data center (SDDC) contains the resources required for a functional VMware environment. Instances in an SDDC (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the SDDC. The SDDC uses a single management subnet for provisioning the SDDC. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.
type Sddc struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. Id *string `mandatory:"true" json:"id"` // The availability domain the ESXi hosts are running in. // Example: `Uocm:PHX-AD-1` ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"` // A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits, // whitespaces, dashes and underscores. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // In general, this is a specific version of bundled VMware software supported by // Oracle Cloud VMware Solution (see // ListSupportedVmwareSoftwareVersions). // This attribute is not guaranteed to reflect the version of // software currently installed on the ESXi hosts in the SDDC. The purpose // of this attribute is to show the version of software that the Oracle // Cloud VMware Solution will install on any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer // version of bundled VMware software supported by the Oracle Cloud VMware Solution, you // should use UpdateSddc to update the SDDC's // `vmwareSoftwareVersion` with that new version. VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the SDDC. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The number of ESXi hosts in the SDDC. EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"` // FQDN for vCenter // Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com` VcenterFqdn *string `mandatory:"true" json:"vcenterFqdn"` // FQDN for NSX Manager // Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` NsxManagerFqdn *string `mandatory:"true" json:"nsxManagerFqdn"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is // the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the // Core Services API. VcenterPrivateIpId *string `mandatory:"true" json:"vcenterPrivateIpId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is // the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the // Core Services API. NsxManagerPrivateIpId *string `mandatory:"true" json:"nsxManagerPrivateIpId"` // One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for // the default user on each ESXi host. Use a newline character to separate multiple keys. // The SSH keys must be in the format required for the `authorized_keys` file. // This attribute is not guaranteed to reflect the public SSH keys // currently installed on the ESXi hosts in the SDDC. The purpose // of this attribute is to show the public SSH keys that Oracle // Cloud VMware Solution will install on any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different // SSH keys, you should use UpdateSddc to update // the SDDC's `sshAuthorizedKeys` with the new public keys. SshAuthorizedKeys *string `mandatory:"true" json:"sshAuthorizedKeys"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the management subnet used // to provision the SDDC. ProvisioningSubnetId *string `mandatory:"true" json:"provisioningSubnetId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the vSphere component of the VMware environment. // This attribute is not guaranteed to reflect the vSphere VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the vSphere VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the vSphere component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `vsphereVlanId` with that new VLAN's OCID. VsphereVlanId *string `mandatory:"true" json:"vsphereVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the vMotion component of the VMware environment. // This attribute is not guaranteed to reflect the vMotion VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the vMotion VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the vMotion component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `vmotionVlanId` with that new VLAN's OCID. VmotionVlanId *string `mandatory:"true" json:"vmotionVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the vSAN component of the VMware environment. // This attribute is not guaranteed to reflect the vSAN VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the vSAN VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the vSAN component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `vsanVlanId` with that new VLAN's OCID. VsanVlanId *string `mandatory:"true" json:"vsanVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the NSX VTEP component of the VMware environment. // This attribute is not guaranteed to reflect the NSX VTEP VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the NSX VTEP VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the NSX VTEP component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `nsxVTepVlanId` with that new VLAN's OCID. NsxVTepVlanId *string `mandatory:"true" json:"nsxVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the NSX Edge VTEP component of the VMware environment. // This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the NSX Edge VTEP VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the NSX Edge VTEP component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `nsxEdgeVTepVlanId` with that new VLAN's OCID. NsxEdgeVTepVlanId *string `mandatory:"true" json:"nsxEdgeVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the NSX Edge Uplink 1 component of the VMware environment. // This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the NSX Edge Uplink 1 component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `nsxEdgeUplink1VlanId` with that new VLAN's OCID. NsxEdgeUplink1VlanId *string `mandatory:"true" json:"nsxEdgeUplink1VlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC // for the NSX Edge Uplink 2 component of the VMware environment. // This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN // currently used by the ESXi hosts in the SDDC. The purpose // of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle // Cloud VMware Solution will use for any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN // for the NSX Edge Uplink 2 component of the VMware environment, you // should use UpdateSddc to update the SDDC's // `nsxEdgeUplink2VlanId` with that new VLAN's OCID. NsxEdgeUplink2VlanId *string `mandatory:"true" json:"nsxEdgeUplink2VlanId"` // The date and time the SDDC was created, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). // Example: `2016-08-25T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"true" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"` // A prefix used in the name of each ESXi host and Compute instance in the SDDC. // If this isn't set, the SDDC's `displayName` is used as the prefix. // For example, if the value is `MySDDC`, the ESXi hosts are named `MySDDC-1`, // `MySDDC-2`, and so on. InstanceDisplayNamePrefix *string `mandatory:"false" json:"instanceDisplayNamePrefix"` // The SDDC includes an administrator username and initial password for vCenter. Make sure // to change this initial vCenter password to a different value. VcenterInitialPassword *string `mandatory:"false" json:"vcenterInitialPassword"` // The SDDC includes an administrator username and initial password for NSX Manager. Make sure // to change this initial NSX Manager password to a different value. NsxManagerInitialPassword *string `mandatory:"false" json:"nsxManagerInitialPassword"` // The SDDC includes an administrator username and initial password for vCenter. You can // change this initial username to a different value in vCenter. VcenterUsername *string `mandatory:"false" json:"vcenterUsername"` // The SDDC includes an administrator username and initial password for NSX Manager. You // can change this initial username to a different value in NSX Manager. NsxManagerUsername *string `mandatory:"false" json:"nsxManagerUsername"` // The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application // workloads. WorkloadNetworkCidr *string `mandatory:"false" json:"workloadNetworkCidr"` // The VMware NSX overlay workload segment to host your application. Connect to workload // portgroup in vCenter to access this overlay segment. NsxOverlaySegmentName *string `mandatory:"false" json:"nsxOverlaySegmentName"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is // the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for // route table rules when setting up connectivity between the SDDC and other networks. // For information about `PrivateIp` objects, see the Core Services API. NsxEdgeUplinkIpId *string `mandatory:"false" json:"nsxEdgeUplinkIpId"` // HCX Private IP HcxPrivateIpId *string `mandatory:"false" json:"hcxPrivateIpId"` // HCX Fully Qualified Domain Name HcxFqdn *string `mandatory:"false" json:"hcxFqdn"` // HCX initial password HcxInitialPassword *string `mandatory:"false" json:"hcxInitialPassword"` // HCX vlan id HcxVlanId *string `mandatory:"false" json:"hcxVlanId"` // HCX enabled or not IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"` // HCX on-premise license key HcxOnPremKey *string `mandatory:"false" json:"hcxOnPremKey"` // The date and time the SDDC was updated, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current state of the SDDC. LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m Sddc) String() string
SddcClient a client for Sddc
type SddcClient struct { common.BaseClient // contains filtered or unexported fields }
func NewSddcClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SddcClient, err error)
NewSddcClientWithConfigurationProvider Creates a new default Sddc client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSddcClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SddcClient, err error)
NewSddcClientWithOboToken Creates a new default Sddc client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client SddcClient) ChangeSddcCompartment(ctx context.Context, request ChangeSddcCompartmentRequest) (response ChangeSddcCompartmentResponse, err error)
ChangeSddcCompartment Moves an SDDC into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ChangeSddcCompartment.go.html to see an example of how to use ChangeSddcCompartment API.
func (client *SddcClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SddcClient) CreateSddc(ctx context.Context, request CreateSddcRequest) (response CreateSddcResponse, err error)
CreateSddc Creates a software-defined data center (SDDC). Use the WorkRequest operations to track the creation of the SDDC.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/CreateSddc.go.html to see an example of how to use CreateSddc API.
func (client SddcClient) DeleteSddc(ctx context.Context, request DeleteSddcRequest) (response DeleteSddcResponse, err error)
DeleteSddc Deletes the specified SDDC, along with the other resources that were created with the SDDC. For example: the Compute instances, DNS records, and so on. Use the WorkRequest operations to track the deletion of the SDDC.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/DeleteSddc.go.html to see an example of how to use DeleteSddc API.
func (client SddcClient) GetSddc(ctx context.Context, request GetSddcRequest) (response GetSddcResponse, err error)
GetSddc Gets the specified SDDC's information.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetSddc.go.html to see an example of how to use GetSddc API.
func (client SddcClient) ListSddcs(ctx context.Context, request ListSddcsRequest) (response ListSddcsResponse, err error)
ListSddcs Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSddcs.go.html to see an example of how to use ListSddcs API.
func (client SddcClient) ListSupportedVmwareSoftwareVersions(ctx context.Context, request ListSupportedVmwareSoftwareVersionsRequest) (response ListSupportedVmwareSoftwareVersionsResponse, err error)
ListSupportedVmwareSoftwareVersions Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListSupportedVmwareSoftwareVersions.go.html to see an example of how to use ListSupportedVmwareSoftwareVersions API.
func (client *SddcClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client SddcClient) UpdateSddc(ctx context.Context, request UpdateSddcRequest) (response UpdateSddcResponse, err error)
UpdateSddc Updates the specified SDDC. **Important:** Updating an SDDC affects only certain attributes in the `Sddc` object and does not affect the VMware environment currently running in the SDDC. For more information, see UpdateSddcDetails.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddc API.
SddcCollection A list of SDDCs.
type SddcCollection struct { // A list of SDDCs. Items []SddcSummary `mandatory:"true" json:"items"` }
func (m SddcCollection) String() string
SddcSummary A summary of the SDDC.
type SddcSummary struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the SDDC. Id *string `mandatory:"true" json:"id"` // The availability domain that the SDDC's ESXi hosts are running in. ComputeAvailabilityDomain *string `mandatory:"true" json:"computeAvailabilityDomain"` // A descriptive name for the SDDC. It must be unique, start with a letter, and contain only letters, digits, // whitespaces, dashes and underscores. // Avoid entering confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // In general, this is a specific version of bundled VMware software supported by // Oracle Cloud VMware Solution (see // ListSupportedVmwareSoftwareVersions). // This attribute is not guaranteed to reflect the version of // software currently installed on the ESXi hosts in the SDDC. The purpose // of this attribute is to show the version of software that the Oracle // Cloud VMware Solution will install on any new ESXi hosts that you *add to this // SDDC in the future* with CreateEsxiHost. // Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer // version of bundled VMware software supported by the Oracle Cloud VMware Solution, you // should use UpdateSddc to update the SDDC's // `vmwareSoftwareVersion` with that new version. VmwareSoftwareVersion *string `mandatory:"true" json:"vmwareSoftwareVersion"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the SDDC. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The number of ESXi hosts in the SDDC. EsxiHostsCount *int `mandatory:"true" json:"esxiHostsCount"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"true" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"` // HCX Fully Qualified Domain Name HcxFqdn *string `mandatory:"false" json:"hcxFqdn"` // HCX enabled or not IsHcxEnabled *bool `mandatory:"false" json:"isHcxEnabled"` // FQDN for vCenter // Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com` VcenterFqdn *string `mandatory:"false" json:"vcenterFqdn"` // FQDN for NSX Manager // Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` NsxManagerFqdn *string `mandatory:"false" json:"nsxManagerFqdn"` // The date and time the SDDC was created, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). // Example: `2016-08-25T21:10:29.600Z` TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // The date and time the SDDC was updated, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current state of the SDDC. LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"` }
func (m SddcSummary) String() string
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const ( SortOrdersAsc SortOrdersEnum = "ASC" SortOrdersDesc SortOrdersEnum = "DESC" )
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
SupportedVmwareSoftwareVersionCollection A list of the supported versions of bundled VMware software.
type SupportedVmwareSoftwareVersionCollection struct { // A list of the supported versions of bundled VMware software. Items []SupportedVmwareSoftwareVersionSummary `mandatory:"true" json:"items"` }
func (m SupportedVmwareSoftwareVersionCollection) String() string
SupportedVmwareSoftwareVersionSummary A specific version of bundled VMware software supported by the Oracle Cloud VMware Solution.
type SupportedVmwareSoftwareVersionSummary struct { // A short, unique string that identifies the version of bundled software. Version *string `mandatory:"true" json:"version"` // A description of the software in the bundle. Description *string `mandatory:"true" json:"description"` }
func (m SupportedVmwareSoftwareVersionSummary) String() string
UpdateEsxiHostDetails The ESXi host information to be updated.
type UpdateEsxiHostDetails struct { // A descriptive name for the ESXi host. It's changeable. // Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the SDDC. // Avoid entering confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateEsxiHostDetails) String() string
UpdateEsxiHostRequest wrapper for the UpdateEsxiHost operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateEsxiHost.go.html to see an example of how to use UpdateEsxiHostRequest.
type UpdateEsxiHostRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the ESXi host. EsxiHostId *string `mandatory:"true" contributesTo:"path" name:"esxiHostId"` // The information to be updated. UpdateEsxiHostDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateEsxiHostRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEsxiHostRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEsxiHostRequest) String() string
UpdateEsxiHostResponse wrapper for the UpdateEsxiHost operation
type UpdateEsxiHostResponse struct { // The underlying http response RawResponse *http.Response // The EsxiHost instance EsxiHost `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateEsxiHostResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEsxiHostResponse) String() string
UpdateSddcDetails The SDDC information to be updated. **Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes affect the existing SDDC. Changing the other attributes affects the `Sddc` object, but not the VMware environment currently running on that SDDC. Those other attributes are used by the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost.
type UpdateSddcDetails struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. // SDDC name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. DisplayName *string `mandatory:"false" json:"displayName"` // The version of bundled VMware software that the Oracle Cloud VMware Solution will // install on any new ESXi hosts that you add to this SDDC in the future. // For the list of versions supported by the Oracle Cloud VMware Solution, see // ListSupportedVmwareSoftwareVersions). VmwareSoftwareVersion *string `mandatory:"false" json:"vmwareSoftwareVersion"` // One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for // the default user on each ESXi host, only when adding new ESXi hosts to this SDDC. // Use a newline character to separate multiple keys. // The SSH keys must be in the format required for the `authorized_keys` file. SshAuthorizedKeys *string `mandatory:"false" json:"sshAuthorizedKeys"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the vSphere component of the VMware environment when adding new ESXi hosts to the SDDC. VsphereVlanId *string `mandatory:"false" json:"vsphereVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the vMotion component of the VMware environment when adding new ESXi hosts to the SDDC. VmotionVlanId *string `mandatory:"false" json:"vmotionVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the vSAN component of the VMware environment when adding new ESXi hosts to the SDDC. VsanVlanId *string `mandatory:"false" json:"vsanVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the NSX VTEP component of the VMware environment when adding new ESXi hosts to the SDDC. NsxVTepVlanId *string `mandatory:"false" json:"nsxVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the NSX Edge VTEP component of the VMware environment when adding new ESXi hosts to the SDDC. NsxEdgeVTepVlanId *string `mandatory:"false" json:"nsxEdgeVTepVlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the NSX Edge Uplink 1 component of the VMware environment when adding new ESXi hosts to the SDDC. NsxEdgeUplink1VlanId *string `mandatory:"false" json:"nsxEdgeUplink1VlanId"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VLAN to use for // the NSX Edge Uplink 2 component of the VMware environment when adding new ESXi hosts to the SDDC. NsxEdgeUplink2VlanId *string `mandatory:"false" json:"nsxEdgeUplink2VlanId"` // This id is editable only when hcxEnabled is true HcxVlanId *string `mandatory:"false" json:"hcxVlanId"` // 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a // namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateSddcDetails) String() string
UpdateSddcRequest wrapper for the UpdateSddc operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/UpdateSddc.go.html to see an example of how to use UpdateSddcRequest.
type UpdateSddcRequest struct { // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the SDDC. SddcId *string `mandatory:"true" contributesTo:"path" name:"sddcId"` // The information to be updated. UpdateSddcDetails `contributesTo:"body"` // For optimistic concurrency control. In the PUT or DELETE call // for a resource, set the `if-match` parameter to the value of the // etag from a previous GET or POST response for that resource. // The resource will be updated or deleted only if the etag you // provide matches the resource's current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // Unique identifier for the request. If you need to contact Oracle about a particular // request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateSddcRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSddcRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSddcRequest) String() string
UpdateSddcResponse wrapper for the UpdateSddc operation
type UpdateSddcResponse struct { // The underlying http response RawResponse *http.Response // The Sddc instance Sddc `presentIn:"body"` // For optimistic concurrency control. See `if-match`. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact // Oracle about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateSddcResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSddcResponse) String() string
WorkRequest An asynchronous work request.
type WorkRequest struct { // The asynchronous operation tracked by this work request. OperationType OperationTypesEnum `mandatory:"true" json:"operationType"` // The status of the work request. Status OperationStatusEnum `mandatory:"true" json:"status"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request. Id *string `mandatory:"true" json:"id"` // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that // contains the work request. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The resources that are affected by this work request. Resources []WorkRequestResource `mandatory:"true" json:"resources"` // The percentage complete of the operation tracked by this work request. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time the work request was created, in the format defined by // RFC3339 (https://tools.ietf.org/html/rfc3339). // Example: `2016-08-25T21:10:29.600Z` TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, // in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time the work request reached a terminal state, either `FAILED` OR // `SUCCEEDED`. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
func (m WorkRequest) String() string
WorkRequestClient a client for WorkRequest
type WorkRequestClient struct { common.BaseClient // contains filtered or unexported fields }
func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
NewWorkRequestClientWithConfigurationProvider Creates a new default WorkRequest client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
NewWorkRequestClientWithOboToken Creates a new default WorkRequest client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the specified work request's information.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for the specified work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for the specified work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in the specified compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/ocvp/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *WorkRequestClient) SetRegion(region string)
SetRegion overrides the region of this client.
WorkRequestCollection A list of work requests.
type WorkRequestCollection struct { // A list of work requests. Items []WorkRequest `mandatory:"true" json:"items"` }
func (m WorkRequestCollection) String() string
WorkRequestError An error encountered while executing an operation that is tracked by a work request.
type WorkRequestError struct { // A machine-usable code for the error that occurred. Code *string `mandatory:"true" json:"code"` // A human-readable error string. Message *string `mandatory:"true" json:"message"` // The date and time the error occurred, in the format defined // by RFC3339 (https://tools.ietf.org/html/rfc3339). Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"` }
func (m WorkRequestError) String() string
WorkRequestErrorCollection A list of work request errors.
type WorkRequestErrorCollection struct { // A list of work request errors. Items []WorkRequestError `mandatory:"true" json:"items"` }
func (m WorkRequestErrorCollection) String() string
WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.
type WorkRequestLogEntry struct { // A human-readable log message. Message *string `mandatory:"true" json:"message"` // The date and time the log message was written, in the format defined // by RFC3339 (https://tools.ietf.org/html/rfc3339). Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"` }
func (m WorkRequestLogEntry) String() string
WorkRequestLogEntryCollection A list of work request logs.
type WorkRequestLogEntryCollection struct { // A list of work request logs. Items []WorkRequestLogEntry `mandatory:"true" json:"items"` }
func (m WorkRequestLogEntryCollection) String() string
WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
type WorkRequestResource struct { // The resource type the work request affects. EntityType *string `mandatory:"true" json:"entityType"` // The way in which this resource was affected by the operation that spawned the // work request. ActionType ActionTypesEnum `mandatory:"true" json:"actionType"` // An OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) or other unique identifier // for the resource. Identifier *string `mandatory:"true" json:"identifier"` // The URI path that you can use for a GET request to access the resource metadata. EntityUri *string `mandatory:"false" json:"entityUri"` }
func (m WorkRequestResource) String() string