Update Auto-Select Settings for a Cluster

Details

API Details
NameUpdate Auto-Select Settings for a Cluster
Description

Updates autoSelectNetwork settings for a cluster in clouds where capacity management is enabled by excluding a cluster from being auto-selected or by including a cluster in the auto-selection process. See the Enable/Disable Capacity Management section for the relevant release for additional context.

MethodPUT
URIv1/capacity/placementResources/placementResourceId/availability
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:

  • This API is only applicable to VMware cloud environments.
  • 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.

  • Be aware that:

    • The endTime must be ahead of startTime by a minimum by 5 minutes.

    • The startTime must be more than current time.

ESB Header

action: update.placementResources.placementResourceId.availability

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

Example 1 – Exclude a Cluster from Auto-Selection

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

Request

{
  "endTime": "2017-07-31T07:55:39.110Z",
  "include": false,
  "startTime": "2017-07-31T07:55:39.110Z",
  "timeZone": "UTC"
}

Response

id: 		1
include:	false
startTime:	1519847501198
endTime:	1519819009000
timeZone:	"GMT-08:00"
now:	false

Example 2 – Include a Cluster for Auto-Selection

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

Request

{
  "include": true
}

Response

None.

Request Attributes

endTime

include
  • Description: Identifies if a cluster is included or excluded from the auto-selection process.
  • Type: Boolean
    • true = The resource is included.
    • false = Default. The resource is excluded.

startTime

timeZone
  • Description: Identifies the timezone for your location

  • Type: String

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String

include
  • Description: Identifies if a cluster is included or excluded from the auto-selection process.
  • Type: Boolean
    • true = The resource is included.
    • false = Default. The resource is excluded.

startTime

endTime

timeZone
  • Description: Identifies the timezone for your location

  • Type: String

now
  • Description: Identifies the date and time at which the exclusion should begin. A designation such as now indicates that the exclusion or inclusion is scheduled to start immediately.
  • Type: Boolean
    • true = The exclusion or inclusion is scheduled to start immediately.
    • false = Default. The exclusion or inclusion is not scheduled to start immediately.



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