/ home / cisco / cisco.dnac / 2.0.7 / module / client_detail

cisco.dnac.client_detail (2.0.7) — module

Manage ClientDetail objects of Clients

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Returns detailed Client information retrieved by Mac Address for any given point of time.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_client_detail
  cisco.dnac.client_detail:
    state: query  # required
    mac_address: SomeValue  # string, required
    timestamp: 1  #  integer
  register: nm_get_client_detail

Inputs

    
timestamp:
    description:
    - Epoch time(in milliseconds) when the Client health data is required.
    type: int

mac_address:
    description:
    - MAC Address of the client.
    required: true
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: clients.get_client_detail
  type: str