cisco.catalystcenter.app_policy_intent_create module -- Resource module for App Policy Intent Create

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.app_policy_intent_create.

New in cisco.catalystcenter 4.0.0

Synopsis 

Manage operation create of the resource App Policy Intent Create.
Create/Update/Delete application policy.

Note

This module has a corresponding action plugin.

Requirements 

The below requirements are needed on the host that executes this module.

catalystcentersdk >= 3.1.3.0.0
python >= 3.5

Parameters 

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
createList list / elements=dictionary	App Policy Intent Create's createList.
advancedPolicyScope dictionary	App Policy Intent Create's advancedPolicyScope.
advancedPolicyScopeElement list / elements=dictionary	App Policy Intent Create's advancedPolicyScopeElement.
groupId list / elements=string	The site(s) ID where the Application QoS Policy will be deployed.
ssid list / elements=string	Ssid.
name string	Policy name.
consumer dictionary	App Policy Intent Create's consumer.
scalableGroup list / elements=dictionary	App Policy Intent Create's scalableGroup.
idRef string	Id ref to application Scalable group.
contract dictionary	App Policy Intent Create's contract.
idRef string	Id ref to Queueing profile.
deletePolicyStatus string	NONE deployed policy to devices, DELETED delete policy from devices, RESTORED restored to original configuration.
exclusiveContract dictionary	App Policy Intent Create's exclusiveContract.
clause list / elements=dictionary	App Policy Intent Create's clause.
deviceRemovalBehavior string	Device eemoval behavior.
hostTrackingEnabled boolean	Is host tracking enabled. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
relevanceLevel string	Relevance level.
type string	Type.
name string	Concatination of <polcy name>_<application-set-name> or <polcy name>_global_policy_configuration or <polcy name>_queuing_customization.
policyScope string	Policy name.
priority string	Set to 4095 while producer refer to application Scalable group otherwise 100.
producer dictionary	App Policy Intent Create's producer.
scalableGroup list / elements=dictionary	App Policy Intent Create's scalableGroup.
idRef string	Id ref to application-set or application Scalable group.
deleteList list / elements=string	Delete list of Group Based Policy ids.
updateList list / elements=dictionary	App Policy Intent Create's updateList.
advancedPolicyScope dictionary	App Policy Intent Create's advancedPolicyScope.
advancedPolicyScopeElement list / elements=dictionary	App Policy Intent Create's advancedPolicyScopeElement.
groupId list / elements=string	The site(s) ID where the Application QoS Policy will be deployed.
id string	Id of Advance policy scope element.
ssid list / elements=string	Ssid.
id string	Id of Advance policy scope.
name string	Policy name.
consumer dictionary	App Policy Intent Create's consumer.
id string	Id of Consumer.
scalableGroup list / elements=dictionary	App Policy Intent Create's scalableGroup.
idRef string	Id ref to application Scalable group.
contract dictionary	App Policy Intent Create's contract.
idRef string	Id ref to Queueing profile.
deletePolicyStatus string	NONE deployed policy to devices, DELETED delete policy from devices, RESTORED restored to original configuration.
exclusiveContract dictionary	App Policy Intent Create's exclusiveContract.
clause list / elements=dictionary	App Policy Intent Create's clause.
deviceRemovalBehavior string	Device removal behavior.
hostTrackingEnabled boolean	Host tracking enabled. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
id string	Id of Business relevance or Application policy knobs clause.
relevanceLevel string	Relevance level.
type string	Type.
id string	Id of Exclusive contract.
id string	Id of Group based policy.
name string	Concatination of <polcy name>_<application-set-name> or <polcy name>_global_policy_configuration or <polcy name>_queuing_customization.
policyScope string	Policy name.
priority string	Set to 4095 while producer refer to application Scalable group otherwise 100.
producer dictionary	App Policy Intent Create's producer.
id string	Id of Producer.
scalableGroup list / elements=dictionary	App Policy Intent Create's scalableGroup.
idRef string	Id ref to application-set or application Scalable group.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes 

Note

SDK Method used are application_policy.ApplicationPolicy.application_policy_intent,
Paths used are post /dna/intent/api/v1/app-policy-intent,
Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK

Examples 

---
- name: Create
  cisco.catalystcenter.app_policy_intent_create:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    createList:
      - advancedPolicyScope:
          advancedPolicyScopeElement:
            - groupId:
                - string
              ssid:
                - string
          name: string
        consumer:
          scalableGroup:
            - idRef: string
        contract:
          idRef: string
        deletePolicyStatus: string
        exclusiveContract:
          clause:
            - deviceRemovalBehavior: string
              hostTrackingEnabled: true
              relevanceLevel: string
              type: string
        name: string
        policyScope: string
        priority: string
        producer:
          scalableGroup:
            - idRef: string
    deleteList:
      - string
    updateList:
      - advancedPolicyScope:
          advancedPolicyScopeElement:
            - groupId:
                - string
              id: string
              ssid:
                - string
          id: string
          name: string
        consumer:
          id: string
          scalableGroup:
            - idRef: string
        contract:
          idRef: string
        deletePolicyStatus: string
        exclusiveContract:
          clause:
            - deviceRemovalBehavior: string
              hostTrackingEnabled: true
              id: string
              relevanceLevel: string
              type: string
          id: string
        id: string
        name: string
        policyScope: string
        priority: string
        producer:
          id: string
          scalableGroup:
            - idRef: string

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.catalystcenter.app_policy_intent_create module -- Resource module for App Policy Intent Create

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 