racampos.dnac.network_device_functional_capability (0.0.1) — module

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

Returns the functional-capability for given devices.

Returns functional capability with given Id.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: get_functional_capability_for_devices
  cisco.dnac.network_device_functional_capability:
    state: query  # required
    device_id: SomeValue  # string, required
    function_name: SomeValue  # string
  register: query_result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  
- name: get_functional_capability_by_id
  cisco.dnac.network_device_functional_capability:
    state: query  # required
    id: SomeValue  # string, required
  register: query_result

Inputs

    
id:
    description:
    - Functional Capability UUID.
    required: true
    type: str

device_id:
    description:
    - Accepts comma separated deviceid's and return list of functional-capabilities for
      the given id's. If invalid or not-found id's are provided, null entry will be returned
      in the list.
    required: true
    type: str

function_name:
    description:
    - FunctionName query parameter.
    type: str

Outputs

get_functional_capability_by_id:
  contains: null
  description: Returns functional capability with given Id.
  response:
    contains:
      attributeInfo:
        description: It is the network device functional capability's attributeInfo.
        returned: always
        type: dict
      functionDetails:
        contains:
          attributeInfo:
            description: It is the network device functional capability's attributeInfo.
            returned: always
            type: dict
          id:
            description: It is the network device functional capability's id.
            returned: always
            sample: '478012'
            type: str
          propertyName:
            description: It is the network device functional capability's propertyName.
            returned: always
            sample: <propertyname>
            type: str
          stringValue:
            description: It is the network device functional capability's stringValue.
            returned: always
            sample: <stringvalue>
            type: str
        description: It is the network device functional capability's functionDetails.
        returned: always
        type: list
      functionName:
        description: It is the network device functional capability's functionName.
        returned: always
        sample: <functionname>
        type: str
      functionOpState:
        description: It is the network device functional capability's functionOpState.
        returned: always
        sample: <functionopstate>
        type: str
      id:
        description: It is the network device functional capability's id.
        returned: always
        sample: '478012'
        type: str
    description: Response, property of the response body.
    returned: always
    type: dict
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_functional_capability_for_devices:
  contains: null
  description: Returns the functional-capability for given devices.
  response:
    contains:
      attributeInfo:
        description: It is the network device functional capability's attributeInfo.
        returned: always
        type: dict
      deviceId:
        description: It is the network device functional capability's deviceId.
        returned: always
        sample: <deviceid>
        type: str
      functionalCapability:
        contains:
          attributeInfo:
            description: It is the network device functional capability's attributeInfo.
            returned: always
            type: dict
          functionDetails:
            contains:
              attributeInfo:
                description: It is the network device functional capability's attributeInfo.
                returned: always
                type: dict
              id:
                description: It is the network device functional capability's id.
                returned: always
                sample: '478012'
                type: str
              propertyName:
                description: It is the network device functional capability's propertyName.
                returned: always
                sample: <propertyname>
                type: str
              stringValue:
                description: It is the network device functional capability's stringValue.
                returned: always
                sample: <stringvalue>
                type: str
            description: It is the network device functional capability's functionDetails.
            returned: always
            type: list
          functionName:
            description: It is the network device functional capability's functionName.
            returned: always
            sample: <functionname>
            type: str
          functionOpState:
            description: It is the network device functional capability's functionOpState.
            returned: always
            sample: <functionopstate>
            type: str
          id:
            description: It is the network device functional capability's id.
            returned: always
            sample: '478012'
            type: str
        description: It is the network device functional capability's functionalCapability.
        returned: always
        type: list
      id:
        description: It is the network device functional capability's id.
        returned: always
        sample: '478012'
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str

See also

• cisco.dnac.plugins.module_utils.definitions.network_device_functional_capability
• NetworkDeviceFunctionalCapability reference: Complete reference of the NetworkDeviceFunctionalCapability object model. link
• NetworkDeviceFunctionalCapability reference: SDK reference. link