/ home / cisco / cisco.dnac / 2.0.7 / module / sda_border_device

cisco.dnac.sda_border_device (2.0.7) — module

Manage SdaBorderDevice objects of Sda

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

Gets border device detail from SDA Fabric.

Deletes border device from SDA Fabric.

Adds border device in SDA Fabric.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: gets_border_device_detail
  cisco.dnac.sda_border_device:
    state: query  # required
    device_ipaddress: SomeValue  # string, required
  register: nm_gets_border_device_detail

Scanned by Steampunk Spotter

- name: deletes_border_device
  cisco.dnac.sda_border_device:
    state: delete  # required
    device_ipaddress: SomeValue  # string, required

Scanned by Steampunk Spotter

- name: adds_border_device
  cisco.dnac.sda_border_device:
    state: create  # required
    payload:  # required
    - deviceManagementIpAddress: SomeValue  # string
      siteNameHierarchy: SomeValue  # string
      externalDomainRoutingProtocolName: SomeValue  # string
      externalConnectivityIpPoolName: SomeValue  # string
      internalAutonomouSystemNumber: SomeValue  # string
      borderSessionType: SomeValue  # string
      connectedToInternet: True  # boolean
      externalConnectivitySettings:
      - interfaceName: SomeValue  # string
        externalAutonomouSystemNumber: SomeValue  # string
        l3Handoff:
        - virtualNetwork:
            virtualNetworkName: SomeValue  # string

Inputs

    
payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      borderSessionType:
        description:
        - It is the sda border device's borderSessionType.
        type: str
      connectedToInternet:
        description:
        - It is the sda border device's connectedToInternet.
        type: bool
      deviceManagementIpAddress:
        description:
        - It is the sda border device's deviceManagementIpAddress.
        type: str
      externalConnectivityIpPoolName:
        description:
        - It is the sda border device's externalConnectivityIpPoolName.
        type: str
      externalConnectivitySettings:
        description:
        - It is the sda border device's externalConnectivitySettings.
        elements: dict
        suboptions:
          externalAutonomouSystemNumber:
            description:
            - It is the sda border device's externalAutonomouSystemNumber.
            type: str
          interfaceName:
            description:
            - It is the sda border device's interfaceName.
            type: str
          l3Handoff:
            description:
            - It is the sda border device's l3Handoff.
            elements: dict
            suboptions:
              virtualNetwork:
                description:
                - It is the sda border device's virtualNetwork.
                suboptions:
                  virtualNetworkName:
                    description:
                    - It is the sda border device's virtualNetworkName.
                    type: str
                type: dict
            type: list
        type: list
      externalDomainRoutingProtocolName:
        description:
        - It is the sda border device's externalDomainRoutingProtocolName.
        type: str
      internalAutonomouSystemNumber:
        description:
        - It is the sda border device's internalAutonomouSystemNumber.
        type: str
      siteNameHierarchy:
        description:
        - It is the sda border device's siteNameHierarchy.
        type: str
    type: list

device_ipaddress:
    description:
    - Device IP Address.
    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: sda.adds_border_device
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also