vsphere-automation-vcenter 0.2.2 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -6
- data/README.md +26 -26
- data/docs/CertificateManagementVcenterTlsApi.md +3 -5
- data/docs/DeploymentApi.md +4 -8
- data/docs/DeploymentImportHistoryApi.md +4 -8
- data/docs/DeploymentInstallApi.md +4 -8
- data/docs/DeploymentInstallPscReplicatedApi.md +3 -5
- data/docs/DeploymentInstallPscStandaloneApi.md +3 -5
- data/docs/DeploymentInstallRemotePscApi.md +3 -5
- data/docs/DeploymentQuestionApi.md +3 -5
- data/docs/DeploymentUpgradeApi.md +4 -8
- data/docs/InventoryDatastoreApi.md +3 -5
- data/docs/InventoryNetworkApi.md +3 -5
- data/docs/IsoImageApi.md +6 -10
- data/docs/OvfLibraryItemApi.md +3 -5
- data/docs/StoragePoliciesApi.md +3 -5
- data/docs/TopologyPscsApi.md +3 -5
- data/docs/VcenterDeploymentInfo.md +1 -1
- data/docs/VcenterInventoryDatastoreFindResult.md +1 -1
- data/docs/VcenterInventoryNetworkFindResult.md +1 -1
- data/docs/VcenterOvfLibraryItemResourcePoolDeploymentSpec.md +2 -2
- data/docs/VcenterServicesServiceListDetailsResult.md +1 -1
- data/docs/VcenterStoragePoliciesComplianceSummary.md +1 -1
- data/docs/VcenterStoragePoliciesComplianceVMInfo.md +1 -1
- data/docs/VcenterStoragePoliciesComplianceVMListResult.md +1 -1
- data/docs/VcenterStoragePoliciesVMListResult.md +1 -1
- data/docs/VcenterVMInfo.md +8 -8
- data/docs/VcenterVmGuestLocalFilesystemResult.md +1 -1
- data/docs/VcenterVmStoragePolicyComplianceInfo.md +1 -1
- data/docs/VcenterVmStoragePolicyInfo.md +1 -1
- data/docs/VcenterVmStoragePolicyUpdateSpec.md +1 -1
- data/docs/VcenterVmTemplateLibraryItemsCreateSpec.md +1 -1
- data/docs/VcenterVmTemplateLibraryItemsDeploySpec.md +1 -1
- data/docs/VcenterVmTemplateLibraryItemsHardwareCustomizationSpec.md +2 -2
- data/docs/VcenterVmTemplateLibraryItemsInfo.md +2 -2
- data/docs/VchaClusterActiveApi.md +3 -5
- data/docs/VchaClusterApi.md +3 -5
- data/docs/VchaClusterModeApi.md +3 -5
- data/docs/VchaClusterPassiveApi.md +3 -5
- data/docs/VchaClusterWitnessApi.md +3 -5
- data/docs/VchaVcCredentialsApi.md +3 -5
- data/docs/VmGuestPowerApi.md +3 -5
- data/docs/VmStoragePolicyComplianceApi.md +3 -5
- data/docs/VmTemplateLibraryItemsApi.md +3 -5
- data/lib/vsphere-automation-vcenter/api/certificate_management_vcenter_tls_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_install_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_install_psc_replicated_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_install_psc_standalone_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_install_remote_psc_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_question_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/deployment_upgrade_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/inventory_datastore_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/inventory_network_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/iso_image_api.rb +8 -30
- data/lib/vsphere-automation-vcenter/api/ovf_library_item_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/storage_policies_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/topology_pscs_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_cluster_active_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_cluster_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_cluster_mode_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_cluster_passive_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_cluster_witness_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vcha_vc_credentials_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vm_guest_power_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vm_storage_policy_compliance_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api/vm_template_library_items_api.rb +4 -15
- data/lib/vsphere-automation-vcenter/api_client.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_deployment_info.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_inventory_datastore_find_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_inventory_network_find_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_ovf_library_item_resource_pool_deployment_spec.rb +2 -2
- data/lib/vsphere-automation-vcenter/models/vcenter_services_service_list_details_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_storage_policies_compliance_summary.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_storage_policies_compliance_vm_info.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_storage_policies_compliance_vm_list_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_storage_policies_vm_list_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_guest_local_filesystem_result.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_info.rb +8 -8
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_storage_policy_compliance_info.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_storage_policy_info.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_storage_policy_update_spec.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_template_library_items_create_spec.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_template_library_items_deploy_spec.rb +1 -1
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_template_library_items_hardware_customization_spec.rb +2 -2
- data/lib/vsphere-automation-vcenter/models/vcenter_vm_template_library_items_info.rb +2 -2
- data/lib/vsphere-automation-vcenter/version.rb +1 -1
- data/pkg/vsphere-automation-vcenter-0.2.2.gem +0 -0
- data/vsphere-automation-vcenter.gemspec +2 -2
- metadata +7 -6
@@ -4,14 +4,14 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**cancel**](DeploymentUpgradeApi.md#cancel) | **POST** /vcenter/deployment/upgrade | Cancel the appliance upgrade that is in progress.
|
7
|
+
[**cancel**](DeploymentUpgradeApi.md#cancel) | **POST** /vcenter/deployment/upgrade?action=cancel | Cancel the appliance upgrade that is in progress.
|
8
8
|
[**check**](DeploymentUpgradeApi.md#check) | **POST** /vcenter/deployment/upgrade?action=check | Run sanity checks using the UpgradeSpec parameters passed.
|
9
9
|
[**get**](DeploymentUpgradeApi.md#get) | **GET** /vcenter/deployment/upgrade | Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
|
10
10
|
[**start**](DeploymentUpgradeApi.md#start) | **POST** /vcenter/deployment/upgrade?action=start | Start the appliance installation.
|
11
11
|
|
12
12
|
|
13
13
|
# **cancel**
|
14
|
-
> cancel
|
14
|
+
> cancel
|
15
15
|
|
16
16
|
Cancel the appliance upgrade that is in progress.
|
17
17
|
|
@@ -28,21 +28,17 @@ VSphereAutomation::Configuration.new.tap do |config|
|
|
28
28
|
end
|
29
29
|
|
30
30
|
api_instance = VSphereAutomation::VCenter::DeploymentUpgradeApi.new
|
31
|
-
action = 'action_example' # String | action=cancel
|
32
31
|
|
33
32
|
begin
|
34
33
|
#Cancel the appliance upgrade that is in progress.
|
35
|
-
api_instance.cancel
|
34
|
+
api_instance.cancel
|
36
35
|
rescue VSphereAutomation::ApiError => e
|
37
36
|
puts "Exception when calling DeploymentUpgradeApi->cancel: #{e}"
|
38
37
|
end
|
39
38
|
```
|
40
39
|
|
41
40
|
### Parameters
|
42
|
-
|
43
|
-
Name | Type | Description | Notes
|
44
|
-
------------- | ------------- | ------------- | -------------
|
45
|
-
**action** | **String**| action=cancel |
|
41
|
+
This endpoint does not need any parameter.
|
46
42
|
|
47
43
|
### Return type
|
48
44
|
|
@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**find**](InventoryDatastoreApi.md#find) | **POST** /com/vmware/vcenter/inventory/datastore | Returns datastore information for the specified datastores. The key in the {@term result} {@term map} is the datastore identifier and the value in the {@term map} is the datastore information.
|
7
|
+
[**find**](InventoryDatastoreApi.md#find) | **POST** /com/vmware/vcenter/inventory/datastore?~action=find | Returns datastore information for the specified datastores. The key in the {@term result} {@term map} is the datastore identifier and the value in the {@term map} is the datastore information.
|
8
8
|
|
9
9
|
|
10
10
|
# **find**
|
11
|
-
> VcenterInventoryDatastoreFindResult find(
|
11
|
+
> VcenterInventoryDatastoreFindResult find(request_body)
|
12
12
|
|
13
13
|
Returns datastore information for the specified datastores. The key in the {@term result} {@term map} is the datastore identifier and the value in the {@term map} is the datastore information.
|
14
14
|
|
@@ -25,12 +25,11 @@ VSphereAutomation::Configuration.new.tap do |config|
|
|
25
25
|
end
|
26
26
|
|
27
27
|
api_instance = VSphereAutomation::VCenter::InventoryDatastoreApi.new
|
28
|
-
action = 'action_example' # String | ~action=find
|
29
28
|
request_body = VCenter::VcenterInventoryDatastoreFind.new # VcenterInventoryDatastoreFind |
|
30
29
|
|
31
30
|
begin
|
32
31
|
#Returns datastore information for the specified datastores. The key in the {@term result} {@term map} is the datastore identifier and the value in the {@term map} is the datastore information.
|
33
|
-
result = api_instance.find(
|
32
|
+
result = api_instance.find(request_body)
|
34
33
|
p result
|
35
34
|
rescue VSphereAutomation::ApiError => e
|
36
35
|
puts "Exception when calling InventoryDatastoreApi->find: #{e}"
|
@@ -41,7 +40,6 @@ end
|
|
41
40
|
|
42
41
|
Name | Type | Description | Notes
|
43
42
|
------------- | ------------- | ------------- | -------------
|
44
|
-
**action** | **String**| ~action=find |
|
45
43
|
**request_body** | [**VcenterInventoryDatastoreFind**](VcenterInventoryDatastoreFind.md)| |
|
46
44
|
|
47
45
|
### Return type
|
data/docs/InventoryNetworkApi.md
CHANGED
@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**find**](InventoryNetworkApi.md#find) | **POST** /com/vmware/vcenter/inventory/network | Returns network information for the specified vCenter Server networks. The key in the {@term result} {@term map} is the network identifier and the value in the {@term map} is the network information.
|
7
|
+
[**find**](InventoryNetworkApi.md#find) | **POST** /com/vmware/vcenter/inventory/network?~action=find | Returns network information for the specified vCenter Server networks. The key in the {@term result} {@term map} is the network identifier and the value in the {@term map} is the network information.
|
8
8
|
|
9
9
|
|
10
10
|
# **find**
|
11
|
-
> VcenterInventoryNetworkFindResult find(
|
11
|
+
> VcenterInventoryNetworkFindResult find(request_body)
|
12
12
|
|
13
13
|
Returns network information for the specified vCenter Server networks. The key in the {@term result} {@term map} is the network identifier and the value in the {@term map} is the network information.
|
14
14
|
|
@@ -25,12 +25,11 @@ VSphereAutomation::Configuration.new.tap do |config|
|
|
25
25
|
end
|
26
26
|
|
27
27
|
api_instance = VSphereAutomation::VCenter::InventoryNetworkApi.new
|
28
|
-
action = 'action_example' # String | ~action=find
|
29
28
|
request_body = VCenter::VcenterInventoryNetworkFind.new # VcenterInventoryNetworkFind |
|
30
29
|
|
31
30
|
begin
|
32
31
|
#Returns network information for the specified vCenter Server networks. The key in the {@term result} {@term map} is the network identifier and the value in the {@term map} is the network information.
|
33
|
-
result = api_instance.find(
|
32
|
+
result = api_instance.find(request_body)
|
34
33
|
p result
|
35
34
|
rescue VSphereAutomation::ApiError => e
|
36
35
|
puts "Exception when calling InventoryNetworkApi->find: #{e}"
|
@@ -41,7 +40,6 @@ end
|
|
41
40
|
|
42
41
|
Name | Type | Description | Notes
|
43
42
|
------------- | ------------- | ------------- | -------------
|
44
|
-
**action** | **String**| ~action=find |
|
45
43
|
**request_body** | [**VcenterInventoryNetworkFind**](VcenterInventoryNetworkFind.md)| |
|
46
44
|
|
47
45
|
### Return type
|
data/docs/IsoImageApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**mount**](IsoImageApi.md#mount) | **POST** /com/vmware/vcenter/iso/image/id:{library_item} | Mounts an ISO image from a content library on a virtual machine.
|
8
|
-
[**unmount**](IsoImageApi.md#unmount) | **POST** /com/vmware/vcenter/iso/image/id:{vm} | Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
7
|
+
[**mount**](IsoImageApi.md#mount) | **POST** /com/vmware/vcenter/iso/image/id:{library_item}?~action=mount | Mounts an ISO image from a content library on a virtual machine.
|
8
|
+
[**unmount**](IsoImageApi.md#unmount) | **POST** /com/vmware/vcenter/iso/image/id:{vm}?~action=unmount | Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
9
9
|
|
10
10
|
|
11
11
|
# **mount**
|
12
|
-
> VcenterIsoImageMountResult mount(library_item,
|
12
|
+
> VcenterIsoImageMountResult mount(library_item, request_body)
|
13
13
|
|
14
14
|
Mounts an ISO image from a content library on a virtual machine.
|
15
15
|
|
@@ -27,12 +27,11 @@ end
|
|
27
27
|
|
28
28
|
api_instance = VSphereAutomation::VCenter::IsoImageApi.new
|
29
29
|
library_item = 'library_item_example' # String | The identifier of the library item having the ISO image to mount on the virtual machine.
|
30
|
-
action = 'action_example' # String | ~action=mount
|
31
30
|
request_body = VCenter::VcenterIsoImageMount.new # VcenterIsoImageMount |
|
32
31
|
|
33
32
|
begin
|
34
33
|
#Mounts an ISO image from a content library on a virtual machine.
|
35
|
-
result = api_instance.mount(library_item,
|
34
|
+
result = api_instance.mount(library_item, request_body)
|
36
35
|
p result
|
37
36
|
rescue VSphereAutomation::ApiError => e
|
38
37
|
puts "Exception when calling IsoImageApi->mount: #{e}"
|
@@ -44,7 +43,6 @@ end
|
|
44
43
|
Name | Type | Description | Notes
|
45
44
|
------------- | ------------- | ------------- | -------------
|
46
45
|
**library_item** | **String**| The identifier of the library item having the ISO image to mount on the virtual machine. |
|
47
|
-
**action** | **String**| ~action=mount |
|
48
46
|
**request_body** | [**VcenterIsoImageMount**](VcenterIsoImageMount.md)| |
|
49
47
|
|
50
48
|
### Return type
|
@@ -63,7 +61,7 @@ Name | Type | Description | Notes
|
|
63
61
|
|
64
62
|
|
65
63
|
# **unmount**
|
66
|
-
> unmount(vm,
|
64
|
+
> unmount(vm, request_body)
|
67
65
|
|
68
66
|
Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
69
67
|
|
@@ -81,12 +79,11 @@ end
|
|
81
79
|
|
82
80
|
api_instance = VSphereAutomation::VCenter::IsoImageApi.new
|
83
81
|
vm = 'vm_example' # String | The identifier of the virtual machine from which to unmount the virtual CD-ROM.
|
84
|
-
action = 'action_example' # String | ~action=unmount
|
85
82
|
request_body = VCenter::VcenterIsoImageUnmount.new # VcenterIsoImageUnmount |
|
86
83
|
|
87
84
|
begin
|
88
85
|
#Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
89
|
-
api_instance.unmount(vm,
|
86
|
+
api_instance.unmount(vm, request_body)
|
90
87
|
rescue VSphereAutomation::ApiError => e
|
91
88
|
puts "Exception when calling IsoImageApi->unmount: #{e}"
|
92
89
|
end
|
@@ -97,7 +94,6 @@ end
|
|
97
94
|
Name | Type | Description | Notes
|
98
95
|
------------- | ------------- | ------------- | -------------
|
99
96
|
**vm** | **String**| The identifier of the virtual machine from which to unmount the virtual CD-ROM. |
|
100
|
-
**action** | **String**| ~action=unmount |
|
101
97
|
**request_body** | [**VcenterIsoImageUnmount**](VcenterIsoImageUnmount.md)| |
|
102
98
|
|
103
99
|
### Return type
|
data/docs/OvfLibraryItemApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create**](OvfLibraryItemApi.md#create) | **POST** /com/vmware/vcenter/ovf/library-item | Creates a library item in content library from a virtual machine or virtual appliance. <p> This {@term operation} creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this {@term operation}, the original content is overwritten. </p>
|
8
|
-
[**deploy**](OvfLibraryItemApi.md#deploy) | **POST** /com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id} | Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. <p> This {@term operation} deploys an OVF package which is stored in the library item specified by {@param.name ovfLibraryItemId}. It uses the deployment specification in {@param.name deploymentSpec} to deploy the OVF package to the location specified by {@param.name target}. </p>
|
8
|
+
[**deploy**](OvfLibraryItemApi.md#deploy) | **POST** /com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=deploy | Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. <p> This {@term operation} deploys an OVF package which is stored in the library item specified by {@param.name ovfLibraryItemId}. It uses the deployment specification in {@param.name deploymentSpec} to deploy the OVF package to the location specified by {@param.name target}. </p>
|
9
9
|
[**filter**](OvfLibraryItemApi.md#filter) | **POST** /com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=filter | Queries an OVF package stored in content library to retrieve information to use when deploying the package. See {@link #deploy}. <p> This {@term operation} retrieves information from the descriptor of the OVF package stored in the library item specified by {@param.name ovfLibraryItemId}. The information returned by the {@term operation} can be used to populate the deployment specification (see {@link ResourcePoolDeploymentSpec} when deploying the OVF package to the deployment target specified by {@param.name target}. </p>
|
10
10
|
|
11
11
|
|
@@ -60,7 +60,7 @@ Name | Type | Description | Notes
|
|
60
60
|
|
61
61
|
|
62
62
|
# **deploy**
|
63
|
-
> VcenterOvfLibraryItemDeployResult deploy(ovf_library_item_id,
|
63
|
+
> VcenterOvfLibraryItemDeployResult deploy(ovf_library_item_id, request_body)
|
64
64
|
|
65
65
|
Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. <p> This {@term operation} deploys an OVF package which is stored in the library item specified by {@param.name ovfLibraryItemId}. It uses the deployment specification in {@param.name deploymentSpec} to deploy the OVF package to the location specified by {@param.name target}. </p>
|
66
66
|
|
@@ -78,12 +78,11 @@ end
|
|
78
78
|
|
79
79
|
api_instance = VSphereAutomation::VCenter::OvfLibraryItemApi.new
|
80
80
|
ovf_library_item_id = 'ovf_library_item_id_example' # String | Identifier of the content library item containing the OVF package to be deployed.
|
81
|
-
action = 'action_example' # String | ~action=deploy
|
82
81
|
request_body = VCenter::VcenterOvfLibraryItemDeploy.new # VcenterOvfLibraryItemDeploy |
|
83
82
|
|
84
83
|
begin
|
85
84
|
#Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. <p> This {@term operation} deploys an OVF package which is stored in the library item specified by {@param.name ovfLibraryItemId}. It uses the deployment specification in {@param.name deploymentSpec} to deploy the OVF package to the location specified by {@param.name target}. </p>
|
86
|
-
result = api_instance.deploy(ovf_library_item_id,
|
85
|
+
result = api_instance.deploy(ovf_library_item_id, request_body)
|
87
86
|
p result
|
88
87
|
rescue VSphereAutomation::ApiError => e
|
89
88
|
puts "Exception when calling OvfLibraryItemApi->deploy: #{e}"
|
@@ -95,7 +94,6 @@ end
|
|
95
94
|
Name | Type | Description | Notes
|
96
95
|
------------- | ------------- | ------------- | -------------
|
97
96
|
**ovf_library_item_id** | **String**| Identifier of the content library item containing the OVF package to be deployed. |
|
98
|
-
**action** | **String**| ~action=deploy |
|
99
97
|
**request_body** | [**VcenterOvfLibraryItemDeploy**](VcenterOvfLibraryItemDeploy.md)| |
|
100
98
|
|
101
99
|
### Return type
|
data/docs/StoragePoliciesApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**check_compatibility**](StoragePoliciesApi.md#check_compatibility) | **POST** /vcenter/storage/policies/{policy} | Returns datastore compatibility summary about a specific storage policy.
|
7
|
+
[**check_compatibility**](StoragePoliciesApi.md#check_compatibility) | **POST** /vcenter/storage/policies/{policy}?action=check-compatibility | Returns datastore compatibility summary about a specific storage policy.
|
8
8
|
[**list**](StoragePoliciesApi.md#list) | **GET** /vcenter/storage/policies | Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks.
|
9
9
|
|
10
10
|
|
11
11
|
# **check_compatibility**
|
12
|
-
> VcenterStoragePoliciesCheckCompatibilityResult check_compatibility(policy,
|
12
|
+
> VcenterStoragePoliciesCheckCompatibilityResult check_compatibility(policy, request_body)
|
13
13
|
|
14
14
|
Returns datastore compatibility summary about a specific storage policy.
|
15
15
|
|
@@ -27,12 +27,11 @@ end
|
|
27
27
|
|
28
28
|
api_instance = VSphereAutomation::VCenter::StoragePoliciesApi.new
|
29
29
|
policy = 'policy_example' # String | The storage policy identifier The parameter must be an identifier for the resource type: vcenter.StoragePolicy.
|
30
|
-
action = 'action_example' # String | action=check-compatibility
|
31
30
|
request_body = VCenter::VcenterStoragePoliciesCheckCompatibility.new # VcenterStoragePoliciesCheckCompatibility |
|
32
31
|
|
33
32
|
begin
|
34
33
|
#Returns datastore compatibility summary about a specific storage policy.
|
35
|
-
result = api_instance.check_compatibility(policy,
|
34
|
+
result = api_instance.check_compatibility(policy, request_body)
|
36
35
|
p result
|
37
36
|
rescue VSphereAutomation::ApiError => e
|
38
37
|
puts "Exception when calling StoragePoliciesApi->check_compatibility: #{e}"
|
@@ -44,7 +43,6 @@ end
|
|
44
43
|
Name | Type | Description | Notes
|
45
44
|
------------- | ------------- | ------------- | -------------
|
46
45
|
**policy** | **String**| The storage policy identifier The parameter must be an identifier for the resource type: vcenter.StoragePolicy. |
|
47
|
-
**action** | **String**| action=check-compatibility |
|
48
46
|
**request_body** | [**VcenterStoragePoliciesCheckCompatibility**](VcenterStoragePoliciesCheckCompatibility.md)| |
|
49
47
|
|
50
48
|
### Return type
|
data/docs/TopologyPscsApi.md
CHANGED
@@ -4,11 +4,11 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**decommissiontask**](TopologyPscsApi.md#decommissiontask) | **POST** /vcenter/topology/pscs/{hostname} | Decommission the external Platform Services Controller node.
|
7
|
+
[**decommissiontask**](TopologyPscsApi.md#decommissiontask) | **POST** /vcenter/topology/pscs/{hostname}?action=decommission&vmw-task=true | Decommission the external Platform Services Controller node.
|
8
8
|
|
9
9
|
|
10
10
|
# **decommissiontask**
|
11
|
-
> VcenterTopologyPscsDecommissionTaskResult decommissiontask(hostname,
|
11
|
+
> VcenterTopologyPscsDecommissionTaskResult decommissiontask(hostname, request_body)
|
12
12
|
|
13
13
|
Decommission the external Platform Services Controller node.
|
14
14
|
|
@@ -26,12 +26,11 @@ end
|
|
26
26
|
|
27
27
|
api_instance = VSphereAutomation::VCenter::TopologyPscsApi.new
|
28
28
|
hostname = 'hostname_example' # String | FQDN or IP address of external Platform Services Controller node to be decommissioned.
|
29
|
-
action = 'action_example' # String | action=decommission&vmw-task
|
30
29
|
request_body = VCenter::VcenterTopologyPscsDecommissionTask.new # VcenterTopologyPscsDecommissionTask |
|
31
30
|
|
32
31
|
begin
|
33
32
|
#Decommission the external Platform Services Controller node.
|
34
|
-
result = api_instance.decommissiontask(hostname,
|
33
|
+
result = api_instance.decommissiontask(hostname, request_body)
|
35
34
|
p result
|
36
35
|
rescue VSphereAutomation::ApiError => e
|
37
36
|
puts "Exception when calling TopologyPscsApi->decommissiontask: #{e}"
|
@@ -43,7 +42,6 @@ end
|
|
43
42
|
Name | Type | Description | Notes
|
44
43
|
------------- | ------------- | ------------- | -------------
|
45
44
|
**hostname** | **String**| FQDN or IP address of external Platform Services Controller node to be decommissioned. |
|
46
|
-
**action** | **String**| action=decommission&vmw-task |
|
47
45
|
**request_body** | [**VcenterTopologyPscsDecommissionTask**](VcenterTopologyPscsDecommissionTask.md)| |
|
48
46
|
|
49
47
|
### Return type
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**state** | [**VcenterDeploymentApplianceState**](VcenterDeploymentApplianceState.md) | |
|
7
7
|
**progress** | [**CisTaskProgress**](CisTaskProgress.md) | | [optional]
|
8
8
|
**subtask_order** | **Array<String>** | The ordered list of subtasks for this deployment operation. | [optional]
|
9
|
-
**subtasks** | **Array<
|
9
|
+
**subtasks** | [**Array<VcenterDeploymentInfoSubtasks>**](VcenterDeploymentInfoSubtasks.md) | The map of the deployment subtasks and their status infomation. | [optional]
|
10
10
|
**description** | [**VapiStdLocalizableMessage**](VapiStdLocalizableMessage.md) | |
|
11
11
|
**service** | **String** | Identifier of the service containing the operation. |
|
12
12
|
**operation** | **String** | Identifier of the operation associated with the task. |
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterInventoryDatastoreFindResultValue>**](VcenterInventoryDatastoreFindResultValue.md) | |
|
7
7
|
|
8
8
|
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterInventoryNetworkFindResultValue>**](VcenterInventoryNetworkFindResultValue.md) | |
|
7
7
|
|
8
8
|
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
**name** | **String** | Name assigned to the deployed target virtual machine or virtual appliance. | [optional]
|
7
7
|
**annotation** | **String** | Annotation assigned to the deployed target virtual machine or virtual appliance. | [optional]
|
8
8
|
**accept_all_eula** | **Boolean** | Whether to accept all End User License Agreements. See {@link OvfSummary#eulas}. |
|
9
|
-
**network_mappings** | **Array<
|
10
|
-
**storage_mappings** | **Array<
|
9
|
+
**network_mappings** | [**Array<VcenterOvfLibraryItemResourcePoolDeploymentSpecNetworkMappings>**](VcenterOvfLibraryItemResourcePoolDeploymentSpecNetworkMappings.md) | Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the {@term map} is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. | [optional]
|
10
|
+
**storage_mappings** | [**Array<VcenterOvfLibraryItemResourcePoolDeploymentSpecStorageMappings>**](VcenterOvfLibraryItemResourcePoolDeploymentSpecStorageMappings.md) | Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the {@term map} is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See {@link StorageGroupMapping}. | [optional]
|
11
11
|
**storage_provisioning** | [**VcenterOvfDiskProvisioningType**](VcenterOvfDiskProvisioningType.md) | | [optional]
|
12
12
|
**storage_profile_id** | **String** | Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. | [optional]
|
13
13
|
**locale** | **String** | The locale to use for parsing the OVF descriptor. | [optional]
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterServicesServiceListDetailsResultValue>**](VcenterServicesServiceListDetailsResultValue.md) | |
|
7
7
|
|
8
8
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**vm** | **String** | Identifier of virtual machine When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine. |
|
7
7
|
**vm_home** | [**VcenterStoragePoliciesComplianceStatus**](VcenterStoragePoliciesComplianceStatus.md) | | [optional]
|
8
|
-
**disks** | **Array<
|
8
|
+
**disks** | [**Array<VcenterStoragePoliciesComplianceSummaryDisks>**](VcenterStoragePoliciesComplianceSummaryDisks.md) | List of the virtual hard disk. If unset or empty, virtual machine entity does not have any disks or its disks are not associated with a storage policy. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. | [optional]
|
9
9
|
|
10
10
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**vm_home** | [**VcenterStoragePoliciesComplianceVMStatus**](VcenterStoragePoliciesComplianceVMStatus.md) | | [optional]
|
7
|
-
**disks** | **Array<
|
7
|
+
**disks** | [**Array<VcenterStoragePoliciesComplianceVMInfoDisks>**](VcenterStoragePoliciesComplianceVMInfoDisks.md) | A Map of virtual disks and their compliance status If empty, the virtual machine does not have any disks or its disks are not associated with a storage policy. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. |
|
8
8
|
|
9
9
|
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterStoragePoliciesComplianceVMListResultValue>**](VcenterStoragePoliciesComplianceVMListResultValue.md) | |
|
7
7
|
|
8
8
|
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterStoragePoliciesVMListResultValue>**](VcenterStoragePoliciesVMListResultValue.md) | |
|
7
7
|
|
8
8
|
|
data/docs/VcenterVMInfo.md
CHANGED
@@ -11,13 +11,13 @@ Name | Type | Description | Notes
|
|
11
11
|
**boot_devices** | [**Array<VcenterVmHardwareBootDeviceEntry>**](VcenterVmHardwareBootDeviceEntry.md) | Boot device configuration. If the list has no entries, a server-specific default boot sequence is used. |
|
12
12
|
**cpu** | [**VcenterVmHardwareCpuInfo**](VcenterVmHardwareCpuInfo.md) | |
|
13
13
|
**memory** | [**VcenterVmHardwareMemoryInfo**](VcenterVmHardwareMemoryInfo.md) | |
|
14
|
-
**disks** | **Array<
|
15
|
-
**nics** | **Array<
|
16
|
-
**cdroms** | **Array<
|
17
|
-
**floppies** | **Array<
|
18
|
-
**parallel_ports** | **Array<
|
19
|
-
**serial_ports** | **Array<
|
20
|
-
**sata_adapters** | **Array<
|
21
|
-
**scsi_adapters** | **Array<
|
14
|
+
**disks** | [**Array<VcenterVMInfoDisks>**](VcenterVMInfoDisks.md) | List of disks. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. |
|
15
|
+
**nics** | [**Array<VcenterVMInfoNics>**](VcenterVMInfoNics.md) | List of Ethernet adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Ethernet. |
|
16
|
+
**cdroms** | [**Array<VcenterVMInfoCdroms>**](VcenterVMInfoCdroms.md) | List of CD-ROMs. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Cdrom. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Cdrom. |
|
17
|
+
**floppies** | [**Array<VcenterVMInfoFloppies>**](VcenterVMInfoFloppies.md) | List of floppy drives. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Floppy. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Floppy. |
|
18
|
+
**parallel_ports** | [**Array<VcenterVMInfoParallelPorts>**](VcenterVMInfoParallelPorts.md) | List of parallel ports. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.ParallelPort. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.ParallelPort. |
|
19
|
+
**serial_ports** | [**Array<VcenterVMInfoSerialPorts>**](VcenterVMInfoSerialPorts.md) | List of serial ports. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.SerialPort. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.SerialPort. |
|
20
|
+
**sata_adapters** | [**Array<VcenterVMInfoSataAdapters>**](VcenterVMInfoSataAdapters.md) | List of SATA adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.SataAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.SataAdapter. |
|
21
|
+
**scsi_adapters** | [**Array<VcenterVMInfoScsiAdapters>**](VcenterVMInfoScsiAdapters.md) | List of SCSI adapters. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.ScsiAdapter. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.ScsiAdapter. |
|
22
22
|
|
23
23
|
|
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**value** | **Array<
|
6
|
+
**value** | [**Array<VcenterVmGuestLocalFilesystemResultValue>**](VcenterVmGuestLocalFilesystemResultValue.md) | |
|
7
7
|
|
8
8
|
|
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**overall_compliance** | [**VcenterVmStoragePolicyComplianceStatus**](VcenterVmStoragePolicyComplianceStatus.md) | |
|
7
7
|
**vm_home** | [**VcenterVmStoragePolicyComplianceVmComplianceInfo**](VcenterVmStoragePolicyComplianceVmComplianceInfo.md) | | [optional]
|
8
|
-
**disks** | **Array<
|
8
|
+
**disks** | [**Array<VcenterVmStoragePolicyComplianceInfoDisks>**](VcenterVmStoragePolicyComplianceInfoDisks.md) | The compliance information Compliance.VmComplianceInfo for the virtual machine's virtual disks that are currently associated with a storage policy. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. |
|
9
9
|
|
10
10
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**vm_home** | **String** | Storage Policy associated with virtual machine home. Ifunset, the virtual machine's home directory doesn't have any storage policy. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: vcenter.StoragePolicy. When operations return a value of this structure as a result, the field will be an identifier for the resource type: vcenter.StoragePolicy. | [optional]
|
7
|
-
**disks** | **Array<
|
7
|
+
**disks** | [**Array<VcenterOvfLibraryItemResourcePoolDeploymentSpecNetworkMappings>**](VcenterOvfLibraryItemResourcePoolDeploymentSpecNetworkMappings.md) | Storage policies associated with virtual disks. The values in this map are storage policy identifiers. They will be identifiers for the resource type:vcenter.StoragePolicy If the map is empty, the virtual machine does not have any disks or its disks are not associated with a storage policy. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. |
|
8
8
|
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**vm_home** | [**VcenterVmStoragePolicyVmHomePolicySpec**](VcenterVmStoragePolicyVmHomePolicySpec.md) | | [optional]
|
7
|
-
**disks** | **Array<
|
7
|
+
**disks** | [**Array<VcenterVmStoragePolicyUpdateSpecDisks>**](VcenterVmStoragePolicyUpdateSpecDisks.md) | Storage policy or policies to be used when reconfiguring virtual machine diks. if unset the current storage policy is retained. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: vcenter.vm.hardware.Disk. | [optional]
|
8
8
|
|
9
9
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**library** | **String** | Identifier of the library in which the new library item should be created. |
|
10
10
|
**vm_home_storage** | [**VcenterVmTemplateLibraryItemsCreateSpecVmHomeStorage**](VcenterVmTemplateLibraryItemsCreateSpecVmHomeStorage.md) | | [optional]
|
11
11
|
**disk_storage** | [**VcenterVmTemplateLibraryItemsCreateSpecDiskStorage**](VcenterVmTemplateLibraryItemsCreateSpecDiskStorage.md) | | [optional]
|
12
|
-
**disk_storage_overrides** | **Array<
|
12
|
+
**disk_storage_overrides** | [**Array<VcenterVmTemplateLibraryItemsCreateSpecDiskStorageOverrides>**](VcenterVmTemplateLibraryItemsCreateSpecDiskStorageOverrides.md) | Storage specification for individual disks in the virtual machine template. This is specified as a mapping between disk identifiers in the source virtual machine and their respective storage specifications. | [optional]
|
13
13
|
**placement** | [**VcenterVmTemplateLibraryItemsCreatePlacementSpec**](VcenterVmTemplateLibraryItemsCreatePlacementSpec.md) | | [optional]
|
14
14
|
|
15
15
|
|