/ home / racampos / racampos.dnac / 0.0.1 / module / network_device_module

racampos.dnac.network_device_module (0.0.1) — module

Manage NetworkDeviceModule objects of Devices

| "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 modules by specified device id.

Returns Module info by id.

Returns Module Count.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_modules
  cisco.dnac.network_device_module:
    state: query  # required
    device_id: SomeValue  # string, required
    limit: SomeValue  # string
    name_list: SomeValue  # string
    offset: SomeValue  # string
    operational_state_code_list: SomeValue  # string
    part_number_list: SomeValue  # string
    vendor_equipment_type_list: SomeValue  # string
  register: query_result

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

  
- name: get_module_count
  cisco.dnac.network_device_module:
    state: query  # required
    device_id: SomeValue  # string, required
    count: True  # boolean, required
    name_list: SomeValue  # string
    operational_state_code_list: SomeValue  # string
    part_number_list: SomeValue  # string
    vendor_equipment_type_list: SomeValue  # string
  register: query_result

Inputs

    
id:
    description:
    - Id path parameter.
    required: true
    type: str

count:
    description:
    - If true gets the number of objects.
    required: true
    type: bool

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

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

device_id:
    description:
    - DeviceId query parameter.
    required: true
    type: str

name_list:
    description:
    - NameList query parameter.
    type: str

part_number_list:
    description:
    - PartNumberList query parameter.
    type: str

vendor_equipment_type_list:
    description:
    - VendorEquipmentTypeList query parameter.
    type: str

operational_state_code_list:
    description:
    - OperationalStateCodeList query parameter.
    type: str

Outputs

get_module_count:
  contains: null
  description: Returns Module Count.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_module_info_by_id:
  contains: null
  description: Returns Module info by id.
  response:
    contains:
      assemblyNumber:
        description: It is the network device module's assemblyNumber.
        returned: always
        sample: <assemblynumber>
        type: str
      assemblyRevision:
        description: It is the network device module's assemblyRevision.
        returned: always
        sample: <assemblyrevision>
        type: str
      attributeInfo:
        description: It is the network device module's attributeInfo.
        returned: always
        type: dict
      containmentEntity:
        description: It is the network device module's containmentEntity.
        returned: always
        sample: <containmententity>
        type: str
      description:
        description: It is the network device module's description.
        returned: always
        sample: <description>
        type: str
      entityPhysicalIndex:
        description: It is the network device module's entityPhysicalIndex.
        returned: always
        sample: <entityphysicalindex>
        type: str
      id:
        description: It is the network device module's id.
        returned: always
        sample: '478012'
        type: str
      isFieldReplaceable:
        description: It is the network device module's isFieldReplaceable.
        returned: always
        sample: <isfieldreplaceable>
        type: str
      isReportingAlarmsAllowed:
        description: It is the network device module's isReportingAlarmsAllowed.
        returned: always
        sample: <isreportingalarmsallowed>
        type: str
      manufacturer:
        description: It is the network device module's manufacturer.
        returned: always
        sample: <manufacturer>
        type: str
      moduleIndex:
        description: It is the network device module's moduleIndex.
        returned: always
        sample: 0
        type: int
      name:
        description: It is the network device module's name.
        returned: always
        sample: <name>
        type: str
      operationalStateCode:
        description: It is the network device module's operationalStateCode.
        returned: always
        sample: <operationalstatecode>
        type: str
      partNumber:
        description: It is the network device module's partNumber.
        returned: always
        sample: <partnumber>
        type: str
      serialNumber:
        description: It is the network device module's serialNumber.
        returned: always
        sample: <serialnumber>
        type: str
      vendorEquipmentType:
        description: It is the network device module's vendorEquipmentType.
        returned: always
        sample: <vendorequipmenttype>
        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_modules:
  contains: null
  description: Returns modules by specified device id.
  response:
    contains:
      assemblyNumber:
        description: It is the network device module's assemblyNumber.
        returned: always
        sample: <assemblynumber>
        type: str
      assemblyRevision:
        description: It is the network device module's assemblyRevision.
        returned: always
        sample: <assemblyrevision>
        type: str
      attributeInfo:
        description: It is the network device module's attributeInfo.
        returned: always
        type: dict
      containmentEntity:
        description: It is the network device module's containmentEntity.
        returned: always
        sample: <containmententity>
        type: str
      description:
        description: It is the network device module's description.
        returned: always
        sample: <description>
        type: str
      entityPhysicalIndex:
        description: It is the network device module's entityPhysicalIndex.
        returned: always
        sample: <entityphysicalindex>
        type: str
      id:
        description: It is the network device module's id.
        returned: always
        sample: '478012'
        type: str
      isFieldReplaceable:
        description: It is the network device module's isFieldReplaceable.
        returned: always
        sample: <isfieldreplaceable>
        type: str
      isReportingAlarmsAllowed:
        description: It is the network device module's isReportingAlarmsAllowed.
        returned: always
        sample: <isreportingalarmsallowed>
        type: str
      manufacturer:
        description: It is the network device module's manufacturer.
        returned: always
        sample: <manufacturer>
        type: str
      moduleIndex:
        description: It is the network device module's moduleIndex.
        returned: always
        sample: 0
        type: int
      name:
        description: It is the network device module's name.
        returned: always
        sample: <name>
        type: str
      operationalStateCode:
        description: It is the network device module's operationalStateCode.
        returned: always
        sample: <operationalstatecode>
        type: str
      partNumber:
        description: It is the network device module's partNumber.
        returned: always
        sample: <partnumber>
        type: str
      serialNumber:
        description: It is the network device module's serialNumber.
        returned: always
        sample: <serialnumber>
        type: str
      vendorEquipmentType:
        description: It is the network device module's vendorEquipmentType.
        returned: always
        sample: <vendorequipmenttype>
        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

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also