Create ServiceNow Extension

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameCreate ServiceNow Extension
Description

Create a ServiceNow extension on the CloudCenter platform to use the ServiceNow approval flows to Initiate, terminate, suspend, and resume deployments; Terminate, stop, start, and reboot VMs; Extend aging policy; and Update the ServiceNow CMDB

Allowed Role(s)WM_USER
MethodPOST
URI

v1/extensions/serviceNow

cloudcenter-ccm-backend/api/v1/extensions/serviceNow

Sample Request
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/extensions/serviceNow"
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/extensions/serviceNow"
Release

Introduced in CloudCenter 4.8.2

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • The password parameter is displayed in clear text for users with write or admin access. For all other users, the CloudCenter platform displays ===redacted=== in the password attribute.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.extensions.serviceNow

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

Not applicable

Sample Request Body

{
   "extensionType":"SERVICE_NOW",
   "name":"servicenowextension",
   "description":"ServiceNow extension example",
   "serviceNowConnectionInfo":
   {
      "serviceNowUrl":"ven01317.service-now.com",
      "username":"c3.integration",
      "password":"===redacted===",
   },
   "serviceNowApprovalSettings":{
      "onInitialDeployment":true,
      "onTerminate":true,
      "onSuspendOrStop":true,
      "onResumeOrStart":true,
      "onExtendingAgingPolicy":true,
      "cmdbUpdate":true
   }
}

Response

{
   "perms":[
      "delete",
      "read",
      "access",
      "administration",
      "write"
   ],
   "id":"1",
   "resource":"http://<HOST>:<PORT>/v1/extensions/serviceNow/1",
   "extensionType":"SERVICE_NOW",
   "name":"servicenowextension",
   "description":"ServiceNow extension example",
   "ownerUserId":2,
   "endpoint":"ven01317.service-now.com",
   "lastUpdatedTime":1503560292778,
   "serviceNowConnectionInfo":{
      "serviceNowUrl":"ven01317.service-now.com",
      "username":"c3.integration",
      "password":"===redacted===",
      "encrypted":true
   },
   "serviceNowApprovalSettings":{
      "onInitialDeployment":true,
      "onTerminate":true,
      "onSuspendOrStop":true,
      "onResumeOrStart":true,
      "onExtendingAgingPolicy":true,
      "cmdbUpdate":true
   }
}

Request Attributes

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

serviceNowConnectionInfo
  • Description: Identifies the ServiceNow URL and credentials to connect to the ServiceNow instance must already be up and running before a CloudCenter tenant admin can successfully configure the ServiceNow extension.

  • Type: Sequence of access details

    serviceNowUrl
    • Description: The URL associated with the ServiceNow instance.

      This is not the URL to access the CloudCenter platform

    • Type: String

    username
    • Description: The username of the admin user for the ServiceNow instance.
    • Type: String

    password
    • Description: The password of the admin user for the ServiceNow instance.
    • Type: String

serviceNowApprovalSettings
  • Description: Identifies the workflows enabled for each ServiceNow extension – these workflow ensure that the approval process begins when any operation is submitted from the CloudCenter platform to the ServiceNow instance.

  • Type: Sequence of ServiceNow approval settings

    onInitialDeployment 
    • Description: Identifies if an approval workflow should be triggered for the deployment submission.
    • Type: Boolean
      • true = This workflow must be used for deployment submission.
      • false = Default. This workflow must not be used for deployment submission.

    onTerminate 
    • Description: Identifies if an approval workflow should be triggered for the terminate deployment action.

    • Type: Boolean

      • true = This workflow must be used for the terminate deployment action.

      • false = Default. This workflow must not be used for the terminate deployment action.

    onSuspendOrStop 
    • Description: Identifies if an approval workflow should be triggered for the suspend deployment or the stop VM actions.

    • Type: Boolean

      • true = This workflow must be used for the suspend deployment or the stop VM actions.

      • false = Default. This workflow must not be used for the suspend deployment or the stop VM actions.

    onResumeOrStart 
    • Description: Identifies if an approval workflow should be triggered for the resume deployment or the start/reboot VM actions.

    • Type: Boolean

      • true = This workflow must be used for the resume deployment or the start/reboot VM actions.

      • false = Default. This workflow must not be used  for the resume deployment or the start/reboot VM actions.

    onExtendingAgingPolicy 
    • Description: Identifies if an approval workflow should be triggered when extending the aging policy of a deployment.

    • Type: Boolean

      • true = This workflow is used to extend the aging policy action of a deployment.

      • false = Default. This workflow is not used to extend the aging policy action of a deployment.

    cmdbUpdate 
    • Description: Identifies if the admin has enabled CMDB updates for an extension, then the CMDB is updated accordingly.
    • Type: Boolean
      • true = The ServiceNow CMDB is updated.
      • false = Default. The ServiceNow CMDB is not updated.

Response Attributes

perms (click for additional details)
id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
extensionType
  • Description: Identifies the type of extension on the CloudCenter platform. 

  • Type: Enumeration

    EnumerationDescription
    ACI Identifies this extension as an ACI-specific resource. See ACI and the Configuring ACI Extensions section for the relevant release for additional context.
    SERVICE_NOWIdentifies this extension as an ServiceNow-specific resource. See the Configuring ServiceNow Extensions for the relevant release for additional context.
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

 ownerUserId 
  • DescriptionUnique, system-generated identifier for the owner of the resource. For example, a ServiceNow extension owner's User ID.

  • Type: String

endpoint
  • Description: The URL of the device that is connected to the network directly or indirectly.
    • ACI Extension = The APIC device
    • ServiceNow Extension = The ServiceNow instance
  • Type: String

lastUpdatedTime
  • Description: Date that this resource was last updated. This attribute is the same as the lastUpdated attribute.

  • Type: Long

serviceNowConnectionInfo
  • Description: Identifies the ServiceNow URL and credentials to connect to the ServiceNow instance must already be up and running before a CloudCenter tenant admin can successfully configure the ServiceNow extension.

  • Type: Sequence of access details

    serviceNowUrl
    • Description: The URL associated with the ServiceNow instance.

      This is not the URL to access the CloudCenter platform

    • Type: String

    username
    • Description: The username of the admin user for the ServiceNow instance.
    • Type: String

    password
    • Description: The password of the admin user for the ServiceNow instance.
    • Type: String

    encrypted
    • Description: For security reasons, the password specified in the serviceNowConnectionInfo element is encrypted and saved in the database by default. This ensures that ServiceNow and ACI users do not have to explicitly mention the encrypted password in their payload.

    • Type: Boolean

      • true = Default. The password is encrypted.

      • false = The password is not encrypted.

serviceNowApprovalSettings
  • Description: Identifies the workflows enabled for each ServiceNow extension – these workflow ensure that the approval process begins when any operation is submitted from the CloudCenter platform to the ServiceNow instance.

  • Type: Sequence of ServiceNow approval settings

    onInitialDeployment 
    • Description: Identifies if an approval workflow should be triggered for the deployment submission.
    • Type: Boolean
      • true = This workflow must be used for deployment submission.
      • false = Default. This workflow must not be used for deployment submission.

    onTerminate 
    • Description: Identifies if an approval workflow should be triggered for the terminate deployment action.

    • Type: Boolean

      • true = This workflow must be used for the terminate deployment action.

      • false = Default. This workflow must not be used for the terminate deployment action.

    onSuspendOrStop 
    • Description: Identifies if an approval workflow should be triggered for the suspend deployment or the stop VM actions.

    • Type: Boolean

      • true = This workflow must be used for the suspend deployment or the stop VM actions.

      • false = Default. This workflow must not be used for the suspend deployment or the stop VM actions.

    onResumeOrStart 
    • Description: Identifies if an approval workflow should be triggered for the resume deployment or the start/reboot VM actions.

    • Type: Boolean

      • true = This workflow must be used for the resume deployment or the start/reboot VM actions.

      • false = Default. This workflow must not be used  for the resume deployment or the start/reboot VM actions.

    onExtendingAgingPolicy 
    • Description: Identifies if an approval workflow should be triggered when extending the aging policy of a deployment.

    • Type: Boolean

      • true = This workflow is used to extend the aging policy action of a deployment.

      • false = Default. This workflow is not used to extend the aging policy action of a deployment.

    cmdbUpdate 
    • Description: Identifies if the admin has enabled CMDB updates for an extension, then the CMDB is updated accordingly.
    • Type: Boolean
      • true = The ServiceNow CMDB is updated.
      • false = Default. The ServiceNow CMDB is not updated.


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