cisco.ise.authorization_profile – Resource module for Authorization Profile

Note

This plugin is part of the cisco.ise collection (version 1.2.1).

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

  • Manage operations create, update and delete of the resource Authorization Profile.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
accessType
string
Allowed Values - ACCESS_ACCEPT, - ACCESS_REJECT.
acl
string
Authorization Profile's acl.
advancedAttributes
list / elements=string
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
    Choices:
  • no
  • yes
AgentlessPosture flag.
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
    Choices:
  • no
  • yes
EasywiredSessionCandidate flag.
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
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
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
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
macSecPolicy
string
Allowed Values - MUST_SECURE, - MUST_NOT_SECURE, - SHOULD_SECURE.
name
string
Resource Name.
neat
boolean
    Choices:
  • no
  • yes
Neat flag.
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
    Choices:
  • no
  • yes
ServiceTemplate flag.
trackMovement
boolean
    Choices:
  • no
  • yes
TrackMovement flag.
vlan
dictionary
Authorization Profile's vlan.
nameID
string
Authorization Profile's nameID.
tagID
integer
Valid range is 0-31.
voiceDomainPermission
boolean
    Choices:
  • no
  • yes
VoiceDomainPermission flag.
webAuth
boolean
    Choices:
  • no
  • yes
WebAuth flag.
webRedirection
dictionary
Authorization Profile's webRedirection.
acl
string
Authorization Profile's acl.
displayCertificatesRenewalMessages
boolean
    Choices:
  • no
  • yes
The displayCertificatesRenewalMessages is mandatory when 'WebRedirectionType' value is 'CentralizedWebAuth'. For all other 'WebRedirectionType' values the field must be ignored.
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

  • Does not support check_mode

See Also

See also

Authorization Profile reference

Complete reference of the Authorization Profile object model.

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 Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "name": "string", "description": "string", "advancedAttributes": [ { "leftHandSideDictionaryAttribue": { "AdvancedAttributeValueType": "string", "dictionaryName": "string", "attributeName": "string", "value": "string" }, "rightHandSideAttribueValue": { "AdvancedAttributeValueType": "string", "dictionaryName": "string", "attributeName": "string", "value": "string" } } ], "accessType": "string", "authzProfileType": "string", "vlan": { "nameID": "string", "tagID": 0 }, "reauth": { "timer": 0, "connectivity": "string" }, "airespaceACL": "string", "airespaceIPv6ACL": "string", "webRedirection": { "WebRedirectionType": "string", "acl": "string", "portalName": "string", "staticIPHostNameFQDN": "string", "displayCertificatesRenewalMessages": true }, "acl": "string", "trackMovement": true, "agentlessPosture": true, "serviceTemplate": true, "easywiredSessionCandidate": true, "daclName": "string", "voiceDomainPermission": true, "neat": true, "webAuth": true, "autoSmartPort": "string", "interfaceTemplate": "string", "ipv6ACLFilter": "string", "avcProfile": "string", "macSecPolicy": "string", "asaVpn": "string", "profileName": "string", "ipv6DaclName": "string", "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)