All URIs are relative to https://localhost/api
| Method | HTTP request | Description |
|---|---|---|
| CloudTargetCollectionGet | Get /cloud/targets | |
| CloudTargetCreate | Post /cloud/targets | |
| CloudTargetDelete | Delete /cloud/targets/{uuid} | |
| CloudTargetGet | Get /cloud/targets/{uuid} | |
| CloudTargetModify | Patch /cloud/targets/{uuid} |
CloudTargetResponse CloudTargetCollectionGet(ctx, optional)
Retrieves the collection of cloud targets in the cluster. ### Related ONTAP commands * storage aggregate object-store config show ### Learn more * DOC /cloud/targets
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *CloudTargetCollectionGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CloudTargetCollectionGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| name | optional.String | Filter by name | |
| svmUuid | optional.String | Filter by svm.uuid | |
| svmName | optional.String | Filter by svm.name | |
| authenticationType | optional.String | Filter by authentication_type | |
| port | optional.Int32 | Filter by port | |
| used | optional.Int32 | Filter by used | |
| capUrl | optional.String | Filter by cap_url | |
| snapmirrorUse | optional.String | Filter by snapmirror_use | |
| ipspaceUuid | optional.String | Filter by ipspace.uuid | |
| ipspaceName | optional.String | Filter by ipspace.name | |
| azureAccount | optional.String | Filter by azure_account | |
| owner | optional.String | Filter by owner | |
| container | optional.String | Filter by container | |
| server | optional.String | Filter by server | |
| uuid | optional.String | Filter by uuid | |
| sslEnabled | optional.Bool | Filter by ssl_enabled | |
| certificateValidationEnabled | optional.Bool | Filter by certificate_validation_enabled | |
| providerType | optional.String | Filter by provider_type | |
| accessKey | optional.String | Filter by access_key | |
| fields | optional.Interface of []string | Specify the fields to return. | |
| maxRecords | optional.Int32 | Limit the number of records returned. | |
| returnRecords | optional.Bool | The default is true for GET calls. When set to false, only the number of records is returned. | [default to true] |
| returnTimeout | optional.Int32 | The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached. | [default to 15] |
| orderBy | optional.Interface of []string | Order results by specified fields and optional [asc | desc] direction. Default direction is 'asc' for ascending. |
- Content-Type: application/json, application/hal+json
- Accept: application/json, application/hal+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobLinkResponse CloudTargetCreate(ctx, optional)
Creates a cloud target. ### Required properties * name - Name for the cloud target. * owner - Owner of the target: fabricpool, snapmirror. * provider_type - Type of cloud provider: AWS_S3, Azure_Cloud, SGWS, IBM_COS, AliCloud, GoogleCloud. * server - Fully qualified domain name of the object store server. Required when provider_type is one of the following: SGWS, IBM_COS, AliCloud. * container - Data bucket/container name. * access_key - Access key ID if provider_type is not Azure_Cloud and authentication_type is key. * secret_password - Secret access key if provider_type is not Azure_Cloud and authentication_type is key. * azure_account - Azure account if provider_type is Azure_Cloud. * azure_private_key - Azure access key if provider_type is Azure_Cloud. * cap_url - Full URL of the request to a CAP server for retrieving temporary credentials if authentication_type is cap. * svm.name or svm.uuid - Name or UUID of SVM if owner is snapmirror. * snapmirror_use - Use of the cloud target if owner is snapmirror: data, metadata. ### Recommended optional properties * authentication_type - Authentication used to access the target: key, cap, ec2_iam. * ssl_enabled - SSL/HTTPS enabled or disabled. * port - Port number of the object store that ONTAP uses when establishing a connection. * ipspace - IPspace to use in order to reach the cloud target. ### Default property values * authentication_type - ec2_iam - if running in Cloud Volumes ONTAP in AWS - key - in all other cases. * server - s3.amazonaws.com - if provider_type is AWS_S3 - blob.core.windows.net - if provider_type is Azure_Cloud - storage.googleapis.com - if provider_type is GoogleCloud * ssl_enabled - true * port - 443 if ssl_enabled is true and provider_type is not SGWS - 8082 if ssl_enabled is true and provider_type is SGWS - 80 if ssl_enabled is false and provider_type is not SGWS - 8084 if ssl_enabled is false and provider_type is SGWS * ipspace - Default * certificate_validation_enabled - true * ignore_warnings - false * check_only - false ### Related ONTAP commands * storage aggregate object-store config create ### Learn more * DOC /cloud/targets
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *CloudTargetCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CloudTargetCreateOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| ignoreWarnings | optional.Bool | Specifies whether or not warning codes should be ignored. | |
| checkOnly | optional.Bool | Do not create the target configuration, only check that the POST request succeeds. | |
| info | optional.Interface of CloudTarget | Info specification |
- Content-Type: application/json, application/hal+json
- Accept: application/json, application/hal+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobLinkResponse CloudTargetDelete(ctx, uuid)
Deletes the cloud target specified by the UUID. This request starts a job and returns a link to that job. ### Related ONTAP commands * storage aggregate object-store config delete ### Learn more * DOC /cloud/targets
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | Cloud target UUID |
- Content-Type: application/json, application/hal+json
- Accept: application/json, application/hal+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CloudTarget CloudTargetGet(ctx, uuid, optional)
Retrieves the cloud target specified by the UUID. ### Related ONTAP commands * storage aggregate object-store config show ### Learn more * DOC /cloud/targets
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | Cloud target UUID | |
| optional | *CloudTargetGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CloudTargetGetOpts struct
| Name | Type | Description | Notes |
|---|
fields | optional.Interface of []string| Specify the fields to return. |
- Content-Type: application/json, application/hal+json
- Accept: application/json, application/hal+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobLinkResponse CloudTargetModify(ctx, uuid, optional)
Updates the cloud target specified by the UUID with the fields in the body. This request starts a job and returns a link to that job. ### Related ONTAP commands * storage aggregate object-store config modify ### Learn more * DOC /cloud/targets
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| uuid | string | Cloud target UUID | |
| optional | *CloudTargetModifyOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a CloudTargetModifyOpts struct
| Name | Type | Description | Notes |
|---|
ignoreWarnings | optional.Bool| Specifies whether or not warnings should be ignored. | checkOnly | optional.Bool| Do not modify the configuration, only check that the PATCH request succeeds. | info | optional.Interface of CloudTarget| Info specification |
- Content-Type: application/json, application/hal+json
- Accept: application/json, application/hal+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]