Skip to main content

Create a Plan Rule​

Select

SaaS
Customer Managed

Api to create plan rules. Request body will suggest plan against which rule need to be created and type of entities(workloads type, server groups, regions and all) that need to be referenced for applying that rule against a workload.

Request Body
  • plan object required
  • id int32
  • GUID string
  • name string
  • rank int32

    Optional field to suggest priority/rank of the rule. If not present, we will process rule in the same order they are created.

  • workloads object[]

    This will include list of apptypes that should be evaluated against workload apptype for plan association.

  • id int32
  • name string
  • serverGroups object[]

    This will include list of Server groups that should be evaluated against workload server group for plan association.

  • id int32
  • GUID string
  • name string
  • regions object[]

    This will include list of regions that should be evaluated against workload region for plan association.

  • id int32
  • GUID string
  • name string
  • solutions object[]

    This will include list of solutions that should be evaluated against workload for plan association

  • id int32
  • name string
  • company object
  • id int32
  • name string
  • tags object[]

    This will include list of tags that should be evaluated against workload for plan association

  • GUID string

    GUID for the tag

  • id int32

    Id for the tag

  • name string

    Name for the plan rule tag which need to be matched against tag of the workload.

  • value string

    Possible value that need to matched against value of tag associated to workload.

  • globalConfigInfo object

    Only applicable to Global CommCells. Not applicable for SaaS.

  • name string
  • commcells object[]

    List of Service CommCells where the global configuration should be applied

  • id int32
  • name string
  • guid string
  • displayName string
  • companies object[]

    List of companies where the global configuration should be applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config has to be applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string using for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • applyOnAllCompanies boolean

    Decides whether the global configuration should be applied to all the companies, including the newly created ones

  • actionOnLocalEntity string

    Possible values: [CREATE_NEW, TAKE_OVER, FAIL_IF_EXIST]

    Action that will be taken on the local entity that has the same name as the global entity that needs to be created

Responses

OK

Schema
  • id int32
  • name string
POST /v4/plan/rule

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "plan": {

    "id": 0,

    "GUID": "string",

    "name": "string"

  },

  "rank": 0,

  "workloads": [

    {

      "id": 0,

      "name": "string"

    }

  ],

  "serverGroups": [

    {

      "id": 0,

      "GUID": "string",

      "name": "string"

    }

  ],

  "regions": [

    {

      "id": 0,

      "GUID": "string",

      "name": "string"

    }

  ],

  "solutions": [

    {

      "id": 0,

      "name": "string"

    }

  ],

  "company": {

    "id": 0,

    "name": "string"

  },

  "tags": [

    {

      "GUID": "string",

      "id": 0,

      "name": "string",

      "value": "string"

    }

  ],

  "globalConfigInfo": {

    "name": "string",

    "commcells": [

      {

        "id": 0,

        "name": "string",

        "guid": "string",

        "displayName": "string"

      }

    ],

    "companies": [

      {

        "id": 0,

        "name": "string",

        "guid": "string"

      }

    ],

    "scope": "string",

    "scopeFilterQuery": "string",

    "applyOnAllCommCells": true,

    "applyOnAllCompanies": true,

    "actionOnLocalEntity": "CREATE_NEW"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/Rule' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "GUID": "string",
    "name": "string"
  },
  "rank": 0,
  "workloads": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "serverGroups": [
    {
      "id": 0,
      "GUID": "string",
      "name": "string"
    }
  ],
  "regions": [
    {
      "id": 0,
      "GUID": "string",
      "name": "string"
    }
  ],
  "solutions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "company": {
    "id": 0,
    "name": "string"
  },
  "tags": [
    {
      "GUID": "string",
      "id": 0,
      "name": "string",
      "value": "string"
    }
  ],
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string",
        "displayName": "string"
      }
    ],
    "companies": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "applyOnAllCompanies": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'