// removed jquery ui css and js

Enable/Disable Capacity Management

Details

API Details
NameEnable/Disable Capacity Management
Description
Method
  • POST(for the first call)
  • PUT (subsequent calls)
URI

v1/capacity/regions/regionId

CloudCenter ReleaseIntroduced in CloudCenter 4.8.2.
Notes

General:

  • For additional context on <PORT> usage in the following example(s), see Base URI Format.

API:

  • The capacity management feature is only available for VMware and OpenStack clouds.
  • To use this API, you must use an admin account or a privileged account with roles to execute Capacity Management APIs on the cloud region. This account should have cloud provider privileges with the capability of handling APIs in the cloud. Choose an account that has the privilege to access the capacity of every cluster or zone in the cloud.

  • When Capacity Management is enabled:
    • You have the ability to enable the following settings in the Deployment Environment Defaults or Deploy requests.
      • Enable Auto Select Cluster. See the VMware Cloud Settings section for the relevant release for additional context.
      • Enable Auto Select Zone (OpenStack),
    • Cannot select a cluster or availability zone during deployment because the CloudCenter platform determines the cluster or zone for the deployment at deployment time.

  • If you disable Capacity Management after enabling and configuring this feature, then the configuration settings are maintained but utilization metrics collection activity is stopped. If you then enable Capacity Management again, the utilization metrics collection activity start again.
ESB Header
  • action: create.capacity.regions.regionId
  • action: update.capacity.regions.regionId

See the Enterprise Service Bus (ESB) section for the relevant release for additional context.

Example 1 – Enabling Capacity Management for the First Time (POST)

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>//v1/capacity/regions/2"

Request

{ 
  "enabled" : true
}

Response

{
   "regionId":2,
   "cloudId":2,
   "regionName":"RegionOne",
   "enabled":true,
   "configured":false,
   "allocateNetwork":false
}

Example 2 – Enabling Capacity Management for Subsequent Calls (PUT)

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>//v1/capacity/regions/2"

Request

{ 
  "enabled" : true
}

Response

{
   "regionId":2,
   "cloudId":2,
   "regionName":"RegionOne",
   "enabled":true,
   "configured":false,
   "allocateNetwork":false
}

Example 3 – Disabling Capacity Management

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>//v1/capacity/regions/2"

Request

{ 
  "enabled" : false
}

Response

{
   "regionId":2,
   "cloudId":2,
   "regionName":"RegionOne",
   "enabled":false,
   "configured":false,
   "allocateNetwork":false
}

Request Attributes

regionId
  • DescriptionUnique, system-generated identifier for the cloud region 

  • Type: String

enabled
  • Description: Indicates that this resource has been enabled. The default differs based on the resource.

    • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

    • false = The resource has not been enabled.

  • Type: Boolean

Response Attributes

regionId
  • DescriptionUnique, system-generated identifier for the cloud region 

  • Type: String

cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

regionName
  • DescriptionThe name of this cloud region as listed in the Supported Public Clouds section for the relevant release.
  • Type: String

enabled
  • Description: Indicates that this resource has been enabled. The default differs based on the resource.

    • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

    • false = The resource has not been enabled.

  • Type: Boolean

configured
  • Description: Identifies if the required configurations like cloud account and thresholds are defined in the system.

  • Type: Boolean

    • true = The required configurations are defined.

    • false = Default. The required configurations are not defined.

allocateNetwork
  • Description: Identifies if the network should be auto picked using the custom script that corresponds to the auto-selected cluster or zone.
  • Type: Boolean
    • true = The network should be auto picked using the custom script.
    • false = Default. The network should not be auto picked using the custom script.

© 2017-2019 Cisco Systems, Inc. All rights reserved