cisco.dnac.network (2.0.7) — module

Manage Network objects of NetworkSettings

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

API to get DHCP and DNS center server details.

API to create a Network for DHCP and DNS center server settings.

API to update Network for DHCP and DNS center server settings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_network
  cisco.dnac.network:
    state: query  # required
    site_id: SomeValue  # string
  register: nm_get_network
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create_network
  cisco.dnac.network:
    state: create  # required
    site_id: SomeValue  # string, required
    settings:  # required
      dhcpServer:
      - SomeValue  # string
      dnsServer:
        domainName: SomeValue  # string
        primaryIpAddress: SomeValue  # string
        secondaryIpAddress: SomeValue  # string
      syslogServer:
        ipAddresses:
        - SomeValue  # string
        configureDnacIP: True  # boolean
      snmpServer:
        ipAddresses:
        - SomeValue  # string
        configureDnacIP: True  # boolean
      netflowcollector:
        ipAddress: SomeValue  # string
        port: 1  #  number
      ntpServer:
      - SomeValue  # string
      timezone: SomeValue  # string
      messageOfTheday:
        bannerMessage: SomeValue  # string
        retainExistingBanner: True  # boolean
      network_aaa:
        servers: SomeValue  # string
        ipAddress: SomeValue  # string
        network: SomeValue  # string
        protocol: SomeValue  # string
        sharedSecret: SomeValue  # string
      clientAndEndpoint_aaa:
        servers: SomeValue  # string
        ipAddress: SomeValue  # string
        network: SomeValue  # string
        protocol: SomeValue  # string
        sharedSecret: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: update_network
  cisco.dnac.network:
    state: update  # required
    site_id: SomeValue  # string, required
    settings:  # required
      dhcpServer:
      - SomeValue  # string
      dnsServer:
        domainName: SomeValue  # string
        primaryIpAddress: SomeValue  # string
        secondaryIpAddress: SomeValue  # string
      syslogServer:
        ipAddresses:
        - SomeValue  # string
        configureDnacIP: True  # boolean
      snmpServer:
        ipAddresses:
        - SomeValue  # string
        configureDnacIP: True  # boolean
      netflowcollector:
        ipAddress: SomeValue  # string
        port: 1  #  number
      ntpServer:
      - SomeValue  # string
      timezone: SomeValue  # string
      messageOfTheday:
        bannerMessage: SomeValue  # string
        retainExistingBanner: True  # boolean
      network_aaa:
        servers: SomeValue  # string
        ipAddress: SomeValue  # string
        network: SomeValue  # string
        protocol: SomeValue  # string
        sharedSecret: SomeValue  # string
      clientAndEndpoint_aaa:
        servers: SomeValue  # string
        ipAddress: SomeValue  # string
        network: SomeValue  # string
        protocol: SomeValue  # string
        sharedSecret: SomeValue  # string

Inputs

    
site_id:
    description:
    - Site id to get the Network settings associated with the site.
    - Site id to which site details to associate with the Network settings.
    - Site id to update the Network settings which is associated with the site.
    - Required for states update and create.
    type: str

settings:
    description:
    - Settings, property of the request body.
    required: true
    suboptions:
      clientAndEndpoint_aaa:
        description:
        - It is the Network's clientAndEndpoint_aaa.
        suboptions:
          ipAddress:
            description:
            - It is the Network's ipAddress.
            type: str
          network:
            description:
            - It is the Network's Network.
            type: str
          protocol:
            description:
            - It is the Network's protocol.
            type: str
          servers:
            description:
            - It is the Network's servers.
            type: str
          sharedSecret:
            description:
            - It is the Network's sharedSecret.
            type: str
        type: dict
      dhcpServer:
        description:
        - It is the Network's dhcpServer.
        type: list
      dnsServer:
        description:
        - It is the Network's dnsServer.
        suboptions:
          domainName:
            description:
            - It is the Network's domainName.
            type: str
          primaryIpAddress:
            description:
            - It is the Network's primaryIpAddress.
            type: str
          secondaryIpAddress:
            description:
            - It is the Network's secondaryIpAddress.
            type: str
        type: dict
      messageOfTheday:
        description:
        - It is the Network's messageOfTheday.
        suboptions:
          bannerMessage:
            description:
            - It is the Network's bannerMessage.
            type: str
          retainExistingBanner:
            description:
            - It is the Network's retainExistingBanner.
            type: bool
        type: dict
      netflowcollector:
        description:
        - It is the Network's netflowcollector.
        suboptions:
          ipAddress:
            description:
            - It is the Network's ipAddress.
            type: str
          port:
            description:
            - It is the Network's port.
            type: int
        type: dict
      network_aaa:
        description:
        - It is the Network's Network_aaa.
        suboptions:
          ipAddress:
            description:
            - It is the Network's ipAddress.
            type: str
          network:
            description:
            - It is the Network's Network.
            type: str
          protocol:
            description:
            - It is the Network's protocol.
            type: str
          servers:
            description:
            - It is the Network's servers.
            type: str
          sharedSecret:
            description:
            - It is the Network's sharedSecret.
            type: str
        type: dict
      ntpServer:
        description:
        - It is the Network's ntpServer.
        type: list
      snmpServer:
        description:
        - It is the Network's snmpServer.
        suboptions:
          configureDnacIP:
            description:
            - It is the Network's configureDnacIP.
            type: bool
          ipAddresses:
            description:
            - It is the Network's ipAddresses.
            type: list
        type: dict
      syslogServer:
        description:
        - It is the Network's syslogServer.
        suboptions:
          configureDnacIP:
            description:
            - It is the Network's configureDnacIP.
            type: bool
          ipAddresses:
            description:
            - It is the Network's ipAddresses.
            type: list
        type: dict
      timezone:
        description:
        - It is the Network's timezone.
        type: str
    type: dict

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: network_settings.create_network
  type: str

See also