racampos.dnac.wireless_profile (0.0.1) — module

Manage WirelessProfile objects of Wireless

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Gets either one or all the wireless network profiles if no name is provided for network-profile.

Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

Delete the Wireless Profile from DNAC whose name is provided.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_wireless_profile
  cisco.dnac.wireless_profile:
    state: query  # required
    profile_name: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: create_wireless_profile
  cisco.dnac.wireless_profile:
    state: create  # required
    profileDetails:  # required
      name: SomeValue  # string
      sites:
      - SomeValue  # string
      ssidDetails:
      - name: SomeValue  # string
        type: SomeValue  # string
        enableFabric: True  # boolean
        flexConnect:
          enableFlexConnect: True  # boolean
          localToVlan: 1  #  integer
        interfaceName: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_wireless_profile
  cisco.dnac.wireless_profile:
    state: update  # required
    profileDetails:  # required
      name: SomeValue  # string
      sites:
      - SomeValue  # string
      ssidDetails:
      - name: SomeValue  # string
        type: SomeValue  # string
        enableFabric: True  # boolean
        flexConnect:
          enableFlexConnect: True  # boolean
          localToVlan: 1  #  integer
        interfaceName: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_wireless_profile
  cisco.dnac.wireless_profile:
    state: delete  # required
    wireless_profile_name: SomeValue  # string, required

Inputs

    
profile_name:
    description:
    - ProfileName query parameter.
    type: str

profileDetails:
    description:
    - Profile Details, property of the request body.
    required: true
    suboptions:
      name:
        description:
        - It is the wireless profile's name.
        type: str
      sites:
        description:
        - It is the wireless profile's sites.
        type: list
      ssidDetails:
        description:
        - It is the wireless profile's ssidDetails.
        elements: dict
        suboptions:
          enableFabric:
            description:
            - It is the wireless profile's enableFabric.
            type: bool
          flexConnect:
            description:
            - It is the wireless profile's flexConnect.
            suboptions:
              enableFlexConnect:
                description:
                - It is the wireless profile's enableFlexConnect.
                type: bool
              localToVlan:
                description:
                - It is the wireless profile's localToVlan.
                type: int
            type: dict
          interfaceName:
            description:
            - It is the wireless profile's interfaceName.
            type: str
          name:
            description:
            - It is the wireless profile's name.
            type: str
          type:
            description:
            - It is the wireless profile's type.
            type: str
        type: list
    type: dict

wireless_profile_name:
    description:
    - WirelessProfileName path parameter.
    - Required for state delete.
    type: str

Outputs

create_wireless_profile:
  contains: null
  description: Creates Wireless Network Profile on DNAC and associates sites and SSIDs
    to it.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
delete_wireless_profile:
  contains: null
  description: Delete the Wireless Profile from DNAC whose name is provided.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
get_wireless_profile:
  contains: null
  description: Gets either one or all the wireless network profiles if no name is
    provided for network-profile.
  payload:
    contains:
      profileDetails:
        contains:
          name:
            description: It is the wireless profile's name.
            returned: always
            sample: <name>
            type: str
          sites:
            description: It is the wireless profile's sites.
            returned: always
            type: list
          ssidDetails:
            contains:
              enableFabric:
                description: It is the wireless profile's enableFabric.
                returned: always
                sample: false
                type: bool
              flexConnect:
                contains:
                  enableFlexConnect:
                    description: It is the wireless profile's enableFlexConnect.
                    returned: always
                    sample: false
                    type: bool
                  localToVlan:
                    description: It is the wireless profile's localToVlan.
                    returned: always
                    sample: 0
                    type: int
                description: It is the wireless profile's flexConnect.
                returned: always
                type: dict
              interfaceName:
                description: It is the wireless profile's interfaceName.
                returned: always
                sample: <interfacename>
                type: str
              name:
                description: It is the wireless profile's name.
                returned: always
                sample: <name>
                type: str
              type:
                description: It is the wireless profile's type.
                returned: always
                sample: <type>
                type: str
            description: It is the wireless profile's ssidDetails.
            returned: always
            type: list
        description: It is the wireless profile's profileDetails.
        returned: always
        type: dict
    description: It is the wireless profile's payload.
    returned: always
    type: list
  returned: always
  type: dict
update_wireless_profile:
  contains: null
  description: Updates the wireless Network Profile with updated details provided.
    All sites to be present in the network profile should be provided.
  executionId:
    description: Execution Id, property of the response body.
    returned: changed
    sample: <executionid>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: changed
    sample: <executionstatusurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: changed
    sample: <message>
    type: str
  returned: changed
  type: dict

See also