cisco.ise.authorization_profile module – Resource module for Authorization Profile

Note

This module is part of the cisco.ise collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.authorization_profile.

New in version 1.0.0: of cisco.ise

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

Manage operations create, update and delete of the resource Authorization Profile.
This API creates an authorization profile.
This API deletes an authorization profile.
This API allows the client to update an authorization profile.

Note

This module has a corresponding action plugin.

Requirements 

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

ciscoisesdk >= 2.0.1
python >= 3.5

Parameters 

Parameter	Comments
accessType string	Allowed Values - ACCESS_ACCEPT, - ACCESS_REJECT.
acl string	Authorization Profile’s acl.
advancedAttributes list / elements=dictionary	Authorization Profile’s advancedAttributes.
leftHandSideDictionaryAttribue dictionary	Authorization Profile’s leftHandSideDictionaryAttribue.
AdvancedAttributeValueType string	Authorization Profile’s AdvancedAttributeValueType.
attributeName string	Authorization Profile’s attributeName.
dictionaryName string	Authorization Profile’s dictionaryName.
value string	Authorization Profile’s value.
rightHandSideAttribueValue dictionary	Attribute value can be of type AttributeValue or AdvancedDictionaryAttribute. For AttributeValue the value is String, For AdvancedDictionaryAttribute the value is dictionaryName and attributeName properties.
AdvancedAttributeValueType string	Authorization Profile’s AdvancedAttributeValueType.
attributeName string	Authorization Profile’s attributeName.
dictionaryName string	Authorization Profile’s dictionaryName.
value string	Authorization Profile’s value.
agentlessPosture boolean	AgentlessPosture flag. Choices: no yes
airespaceACL string	Authorization Profile’s airespaceACL.
airespaceIPv6ACL string	Authorization Profile’s airespaceIPv6ACL.
asaVpn string	Authorization Profile’s asaVpn.
authzProfileType string	Allowed Values - SWITCH, - TRUSTSEC, - TACACS SWITCH is used for Standard Authorization Profiles.
autoSmartPort string	Authorization Profile’s autoSmartPort.
avcProfile string	Authorization Profile’s avcProfile.
daclName string	Authorization Profile’s daclName.
description string	Authorization Profile’s description.
easywiredSessionCandidate boolean	EasywiredSessionCandidate flag. Choices: no yes
id string	Resource UUID value.
interfaceTemplate string	Authorization Profile’s interfaceTemplate.
ipv6ACLFilter string	Authorization Profile’s ipv6ACLFilter.
ipv6DaclName string	Authorization Profile’s ipv6DaclName.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise	Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: no yes ← (default)
ise_uses_csrf_token boolean added in 3.0.0 of cisco.ise	Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: no ← (default) yes
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
macSecPolicy string	Allowed Values - MUST_SECURE, - MUST_NOT_SECURE, - SHOULD_SECURE.
name string	Resource Name.
neat boolean	Neat flag. Choices: no yes
profileName string	Authorization Profile’s profileName.
reauth dictionary	Authorization Profile’s reauth.
connectivity string	Allowed Values - DEFAULT, - RADIUS_REQUEST.
timer integer	Valid range is 1-65535.
serviceTemplate boolean	ServiceTemplate flag. Choices: no yes
trackMovement boolean	TrackMovement flag. Choices: no yes
vlan dictionary	Authorization Profile’s vlan.
nameID string	Authorization Profile’s nameID.
tagID integer	Valid range is 0-31.
voiceDomainPermission boolean	VoiceDomainPermission flag. Choices: no yes
webAuth boolean	WebAuth flag. Choices: no yes
webRedirection dictionary	Authorization Profile’s webRedirection.
acl string	Authorization Profile’s acl.
displayCertificatesRenewalMessages boolean	The displayCertificatesRenewalMessages is mandatory when ‘WebRedirectionType’ value is ‘CentralizedWebAuth’. For all other ‘WebRedirectionType’ values the field must be ignored. Choices: no yes
portalName string	A portal that exist in the DB and fits the WebRedirectionType.
staticIPHostNameFQDN string	Authorization Profile’s staticIPHostNameFQDN.
WebRedirectionType string	Value MUST be one of the following CentralizedWebAuth, HotSpot, NativeSupplicanProvisioning, ClientProvisioning. The WebRedirectionType must fit the portalName.

Notes 

Note

SDK Method used are authorization_profile.AuthorizationProfile.create_authorization_profile, authorization_profile.AuthorizationProfile.delete_authorization_profile_by_id, authorization_profile.AuthorizationProfile.update_authorization_profile_by_id,
Paths used are post /ers/config/authorizationprofile, delete /ers/config/authorizationprofile/{id}, put /ers/config/authorizationprofile/{id},
Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection

Examples 

- name: Update by id
  cisco.ise.authorization_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessType: string
    acl: string
    advancedAttributes:
    - leftHandSideDictionaryAttribue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
      rightHandSideAttribueValue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
    agentlessPosture: true
    airespaceACL: string
    airespaceIPv6ACL: string
    asaVpn: string
    authzProfileType: string
    autoSmartPort: string
    avcProfile: string
    daclName: string
    description: string
    easywiredSessionCandidate: true
    id: string
    interfaceTemplate: string
    ipv6ACLFilter: string
    ipv6DaclName: string
    macSecPolicy: string
    name: string
    neat: true
    profileName: string
    reauth:
      connectivity: string
      timer: 0
    serviceTemplate: true
    trackMovement: true
    vlan:
      nameID: string
      tagID: 0
    voiceDomainPermission: true
    webAuth: true
    webRedirection:
      WebRedirectionType: string
      acl: string
      displayCertificatesRenewalMessages: true
      portalName: string
      staticIPHostNameFQDN: string

- name: Delete by id
  cisco.ise.authorization_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.authorization_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessType: string
    acl: string
    advancedAttributes:
    - leftHandSideDictionaryAttribue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
      rightHandSideAttribueValue:
        AdvancedAttributeValueType: string
        attributeName: string
        dictionaryName: string
        value: string
    agentlessPosture: true
    airespaceACL: string
    airespaceIPv6ACL: string
    asaVpn: string
    authzProfileType: string
    autoSmartPort: string
    avcProfile: string
    daclName: string
    description: string
    easywiredSessionCandidate: true
    id: string
    interfaceTemplate: string
    ipv6ACLFilter: string
    ipv6DaclName: string
    macSecPolicy: string
    name: string
    neat: true
    profileName: string
    reauth:
      connectivity: string
      timer: 0
    serviceTemplate: true
    trackMovement: true
    vlan:
      nameID: string
      tagID: 0
    voiceDomainPermission: true
    webAuth: true
    webRedirection:
      WebRedirectionType: string
      acl: string
      displayCertificatesRenewalMessages: true
      portalName: string
      staticIPHostNameFQDN: string

Return Values 

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

Key

Description

ise_response

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”advancedAttributes\”: [\n {\n \”leftHandSideDictionaryAttribue\”: {\n \”AdvancedAttributeValueType\”: \”string\”,\n \”dictionaryName\”: \”string\”,\n \”attributeName\”: \”string\”,\n \”value\”: \”string\”\n },\n \”rightHandSideAttribueValue\”: {\n \”AdvancedAttributeValueType\”: \”string\”,\n \”dictionaryName\”: \”string\”,\n \”attributeName\”: \”string\”,\n \”value\”: \”string\”\n }\n }\n ],\n \”accessType\”: \”string\”,\n \”authzProfileType\”: \”string\”,\n \”vlan\”: {\n \”nameID\”: \”string\”,\n \”tagID\”: 0\n },\n \”reauth\”: {\n \”timer\”: 0,\n \”connectivity\”: \”string\”\n },\n \”airespaceACL\”: \”string\”,\n \”airespaceIPv6ACL\”: \”string\”,\n \”webRedirection\”: {\n \”WebRedirectionType\”: \”string\”,\n \”acl\”: \”string\”,\n \”portalName\”: \”string\”,\n \”staticIPHostNameFQDN\”: \”string\”,\n \”displayCertificatesRenewalMessages\”: true\n },\n \”acl\”: \”string\”,\n \”trackMovement\”: true,\n \”agentlessPosture\”: true,\n \”serviceTemplate\”: true,\n \”easywiredSessionCandidate\”: true,\n \”daclName\”: \”string\”,\n \”voiceDomainPermission\”: true,\n \”neat\”: true,\n \”webAuth\”: true,\n \”autoSmartPort\”: \”string\”,\n \”interfaceTemplate\”: \”string\”,\n \”ipv6ACLFilter\”: \”string\”,\n \”avcProfile\”: \”string\”,\n \”macSecPolicy\”: \”string\”,\n \”asaVpn\”: \”string\”,\n \”profileName\”: \”string\”,\n \”ipv6DaclName\”: \”string\”,\n \”link\”: {\n \”rel\”: \”string\”,\n \”href\”: \”string\”,\n \”type\”: \”string\”\n }\n}\n”

ise_update_response

dictionary

added in 1.1.0 of cisco.ise

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”UpdatedFieldsList\”: {\n \”updatedField\”: [\n {\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n ],\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n}\n”

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.authorization_profile module – Resource module for Authorization Profile

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 