Edit Cluster By Name
Continue provisioning an OpenStack cluster with updated specification
Request
URI
PUT
https://{api_host}//192.168.111.151:8443/v1/clusters/{clusterName}/edit
COPY
Path Parameters
string
clusterName
Required
clusterName
Request Body
ClusterSpec of type(s) application/json
Optional
{
"deployment_type": "string",
"management_cluster": {
"moid": "string",
"name": "string"
},
"name": "string",
"network_mapping": {
"data_network": "string",
"external_network": "string",
"management_network": "string",
"metadata_network": "string"
},
"networkings": [
{
"dns1": "string",
"dns2": "string",
"gateway": "string",
"ip_blocks": [
{
"begin_ip": "string",
"end_ip": "string"
}
],
"name": "string",
"netmask": "string",
"portgroup_moref": "string",
"portgroup_name": "string"
}
],
"openstack_info": {
"availability_zones": [
{
"name": "string"
}
],
"compute": {
"compute_clusters": [
{
"availability_zone_name": "string",
"cluster_moid": "string",
"cluster_name": "string",
"datastore_regex": "string",
"esxi_netmask": "string",
"vcenter_ip": "string"
}
]
},
"identity": {
"ad_domains": [
{
"bind_password": "string",
"bind_user": "string",
"force_ldaps": false,
"ldap_admin_user": "string",
"ldap_certificates": [
"string"
],
"ldap_group_desc_attribute": "string",
"ldap_group_filter": "string",
"ldap_group_id_attribute": "string",
"ldap_group_member_attribute": "string",
"ldap_group_name_attribute": "string",
"ldap_group_objectclass": "string",
"ldap_group_tree_dn": "string",
"ldap_search_scope": "string",
"ldap_url": "string",
"ldap_use_start_tls": false,
"ldap_user_enabled_attribute": "string",
"ldap_user_filter": "string",
"ldap_user_id_attribute": "string",
"ldap_user_mail_attribute": "string",
"ldap_user_name_attribute": "string",
"ldap_user_objectclass": "string",
"ldap_user_pass_attribute": "string",
"ldap_user_tree_dn": "string"
}
],
"admin_project_name": "string",
"sql_domain": {
"admin_password": "string",
"admin_user": "string"
},
"token_expiration_time": "string"
},
"image": {
"datastores": [
{
"datastores": "string",
"vcenter_ip": "string"
}
],
"glance_folder": "string"
},
"network": {
"neutron_backend": "string",
"nsxv": {
"nsxv_dvs_moref": "string",
"nsxv_dvs_name": "string",
"nsxv_edge_cluster_moref": "string",
"nsxv_edge_cluster_name": "string",
"nsxv_edge_ha": "string",
"nsxv_exclusive_router_appliance_size": "string",
"nsxv_external_network_name": "string",
"nsxv_manager": "string",
"nsxv_password": "string",
"nsxv_username": "string",
"nsxv_vdn_scope_moref": "string"
},
"nsxv3": {
"nsxv3_api_managers": "string",
"nsxv3_api_password": "string",
"nsxv3_api_username": "string",
"nsxv3_default_overlay_tz": "string",
"nsxv3_default_tier0_router": "string",
"nsxv3_default_vlan_tz": "string",
"nsxv3_edge_cluster_name": "string",
"nsxv3_edge_cluster_uuid": "string",
"nsxv3_md_shared_password": "string",
"nsxv3_native_dhcp_profile": "string",
"nsxv3_native_dhcp_profile_oms_create": "string",
"nsxv3_native_md_proxy": "string",
"nsxv3_native_md_proxy_oms_create": "string"
}
},
"region_name": "string",
"syslog": {
"port": "string",
"protocol": "string",
"server": "string",
"tag": "string"
},
"vcenter_insecure": "string",
"volumn": {
"cinder_folder": "string"
}
},
"public_access": {
"public_hostname": "string",
"public_vip": "string"
},
"root_ca_certificates": [
"string"
],
"vcenters": [
{
"hostname": "string",
"password": "string",
"username": "string"
}
],
"version": "string"
}object
attributes
Optional
attributes
string
deployment_type
Optional
deployment_type
Possible values are : TINY, SINGLEVM, MEDIUM, LARGE,
string
name
Optional
name
array of string
root_ca_certificates
Optional
root_ca_certificates
string
version
Optional
version
Responses
201
Created
Operation doesn't return any data structure
202
Accepted
Returns Task of type(s) application/json
{
"task_id": 0,
"task_url": "string"
}integer As int64 As int64
task_id
Optional
task_id
string
task_url
Optional
task_url
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
On This Page
Cluster Management Operations
PUT
Change Public VIP
POST
Create Cluster By Spec
DELETE
Delete Cluster By Name
PUT
Edit Cluster By Name
GET
Get All Clusters
GET
Get Cluster By Name
PUT
Update Cluster By Name