/ home / racampos / racampos.dnac / 0.0.1 / module / discovery_job

racampos.dnac.discovery_job (0.0.1) — module

Manage DiscoveryJob objects of Discovery

| "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

Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the "Get Discoveries by range" API.

Returns the list of discovery jobs for the given IP.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_list_of_discoveries_by_discovery_id
  cisco.dnac.discovery_job:
    state: query  # required
    id: SomeValue  # string, required
    ip_address: SomeValue  # string
    limit: 1  #  integer
    offset: 1  #  integer
  register: query_result

Scanned by Steampunk Spotter

  
- name: get_discovery_jobs_by_ip
  cisco.dnac.discovery_job:
    state: query  # required
    ip_address: SomeValue  # string, required
    limit: 1  #  integer
    name: SomeValue  # string
    offset: 1  #  integer
  register: query_result

Inputs

    
id:
    description:
    - Discovery ID.
    required: true
    type: str

name:
    description:
    - Name query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

offset:
    description:
    - Offset query parameter.
    type: int

ip_address:
    description:
    - IpAddress query parameter.
    - Required for state query.
    type: str

Outputs

get_discovery_jobs_by_ip:
  contains: null
  description: Returns the list of discovery jobs for the given IP.
  response:
    contains:
      attributeInfo:
        description: It is the discovery job's attributeInfo.
        returned: always
        type: dict
      cliStatus:
        description: It is the discovery job's cliStatus.
        returned: always
        sample: <clistatus>
        type: str
      discoveryStatus:
        description: It is the discovery job's discoveryStatus.
        returned: always
        sample: <discoverystatus>
        type: str
      endTime:
        description: It is the discovery job's endTime.
        returned: always
        sample: <endtime>
        type: str
      httpStatus:
        description: It is the discovery job's httpStatus.
        returned: always
        sample: <httpstatus>
        type: str
      id:
        description: It is the discovery job's id.
        returned: always
        sample: '478012'
        type: str
      inventoryCollectionStatus:
        description: It is the discovery job's inventoryCollectionStatus.
        returned: always
        sample: <inventorycollectionstatus>
        type: str
      inventoryReachabilityStatus:
        description: It is the discovery job's inventoryReachabilityStatus.
        returned: always
        sample: <inventoryreachabilitystatus>
        type: str
      ipAddress:
        description: It is the discovery job's ipAddress.
        returned: always
        sample: <ipaddress>
        type: str
      jobStatus:
        description: It is the discovery job's jobStatus.
        returned: always
        sample: <jobstatus>
        type: str
      name:
        description: It is the discovery job's name.
        returned: always
        sample: <name>
        type: str
      netconfStatus:
        description: It is the discovery job's netconfStatus.
        returned: always
        sample: <netconfstatus>
        type: str
      pingStatus:
        description: It is the discovery job's pingStatus.
        returned: always
        sample: <pingstatus>
        type: str
      snmpStatus:
        description: It is the discovery job's snmpStatus.
        returned: always
        sample: <snmpstatus>
        type: str
      startTime:
        description: It is the discovery job's startTime.
        returned: always
        sample: <starttime>
        type: str
      taskId:
        description: It is the discovery job's taskId.
        returned: always
        sample: aeed229047801200e0ef563dbb9a71c2
        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
get_list_of_discoveries_by_discovery_id:
  contains: null
  description: Returns the list of discovery jobs for the given Discovery ID. The
    results can be optionally filtered based on IP. Discovery ID can be obtained using
    the "Get Discoveries by range" API.
  response:
    contains:
      attributeInfo:
        description: It is the discovery job's attributeInfo.
        returned: always
        type: dict
      cliStatus:
        description: It is the discovery job's cliStatus.
        returned: always
        sample: <clistatus>
        type: str
      discoveryStatus:
        description: It is the discovery job's discoveryStatus.
        returned: always
        sample: <discoverystatus>
        type: str
      endTime:
        description: It is the discovery job's endTime.
        returned: always
        sample: <endtime>
        type: str
      httpStatus:
        description: It is the discovery job's httpStatus.
        returned: always
        sample: <httpstatus>
        type: str
      id:
        description: It is the discovery job's id.
        returned: always
        sample: '478012'
        type: str
      inventoryCollectionStatus:
        description: It is the discovery job's inventoryCollectionStatus.
        returned: always
        sample: <inventorycollectionstatus>
        type: str
      inventoryReachabilityStatus:
        description: It is the discovery job's inventoryReachabilityStatus.
        returned: always
        sample: <inventoryreachabilitystatus>
        type: str
      ipAddress:
        description: It is the discovery job's ipAddress.
        returned: always
        sample: <ipaddress>
        type: str
      jobStatus:
        description: It is the discovery job's jobStatus.
        returned: always
        sample: <jobstatus>
        type: str
      name:
        description: It is the discovery job's name.
        returned: always
        sample: <name>
        type: str
      netconfStatus:
        description: It is the discovery job's netconfStatus.
        returned: always
        sample: <netconfstatus>
        type: str
      pingStatus:
        description: It is the discovery job's pingStatus.
        returned: always
        sample: <pingstatus>
        type: str
      snmpStatus:
        description: It is the discovery job's snmpStatus.
        returned: always
        sample: <snmpstatus>
        type: str
      startTime:
        description: It is the discovery job's startTime.
        returned: always
        sample: <starttime>
        type: str
      taskId:
        description: It is the discovery job's taskId.
        returned: always
        sample: aeed229047801200e0ef563dbb9a71c2
        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.discovery_job
DiscoveryJob reference: Complete reference of the DiscoveryJob object model. link
DiscoveryJob reference: SDK reference. link