racampos.dnac.sda_border_device (0.0.1) — module

Manage SdaBorderDevice objects of Sda

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

Gets border device detail from SDA Fabric.

Deletes border device from SDA Fabric.

Adds border device in SDA Fabric.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: gets_border_device_detail
  cisco.dnac.sda_border_device:
    state: query  # required
    device_ipaddress: SomeValue  # string, required
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: deletes_border_device
  cisco.dnac.sda_border_device:
    state: delete  # required
    device_ipaddress: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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

adds_border_device:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
deletes_border_device:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
gets_border_device_detail:
  contains: null
  description:
    description: Description, property of the response body.
    returned: always
    sample: <description>
    type: str
  payload:
    contains:
      akcSettingsCfs:
        description: It is the sda border device's akcSettingsCfs.
        returned: always
        type: list
      authEntityClass:
        description: It is the sda border device's authEntityClass.
        returned: always
        sample: 0
        type: int
      authEntityId:
        description: It is the sda border device's authEntityId.
        returned: always
        sample: 0
        type: int
      cfsChangeInfo:
        description: It is the sda border device's cfsChangeInfo.
        returned: always
        type: list
      configs:
        description: It is the sda border device's configs.
        returned: always
        type: list
      createTime:
        description: It is the sda border device's createTime.
        returned: always
        sample: 0
        type: int
      customProvisions:
        description: It is the sda border device's customProvisions.
        returned: always
        type: list
      deployPending:
        description: It is the sda border device's deployPending.
        returned: always
        sample: <deploypending>
        type: str
      deployed:
        description: It is the sda border device's deployed.
        returned: always
        sample: false
        type: bool
      deviceInterfaceInfo:
        description: It is the sda border device's deviceInterfaceInfo.
        returned: always
        type: list
      deviceSettings:
        contains:
          connectedTo:
            description: It is the sda border device's connectedTo.
            returned: always
            type: list
          cpu:
            description: It is the sda border device's cpu.
            returned: always
            sample: 0
            type: int
          deployPending:
            description: It is the sda border device's deployPending.
            returned: always
            sample: <deploypending>
            type: str
          dhcpEnabled:
            description: It is the sda border device's dhcpEnabled.
            returned: always
            sample: false
            type: bool
          displayName:
            description: It is the sda border device's displayName.
            returned: always
            sample: <displayname>
            type: str
          extConnectivitySettings:
            contains:
              deployPending:
                description: It is the sda border device's deployPending.
                returned: always
                sample: <deploypending>
                type: str
              displayName:
                description: It is the sda border device's displayName.
                returned: always
                sample: <displayname>
                type: str
              externalDomainProtocolNumber:
                description: It is the sda border device's externalDomainProtocolNumber.
                returned: always
                sample: <externaldomainprotocolnumber>
                type: str
              id:
                description: It is the sda border device's id.
                returned: always
                sample: '478012'
                type: str
              instanceId:
                description: It is the sda border device's instanceId.
                returned: always
                sample: 0
                type: int
              instanceTenantId:
                description: It is the sda border device's instanceTenantId.
                returned: always
                sample: <instancetenantid>
                type: str
              instanceVersion:
                description: It is the sda border device's instanceVersion.
                returned: always
                sample: 0
                type: int
              interfaceUuid:
                description: It is the sda border device's interfaceUuid.
                returned: always
                sample: <interfaceuuid>
                type: str
              l2Handoff:
                description: It is the sda border device's l2Handoff.
                returned: always
                type: list
              l3Handoff:
                contains:
                  deployPending:
                    description: It is the sda border device's deployPending.
                    returned: always
                    sample: <deploypending>
                    type: str
                  displayName:
                    description: It is the sda border device's displayName.
                    returned: always
                    sample: <displayname>
                    type: str
                  id:
                    description: It is the sda border device's id.
                    returned: always
                    sample: '478012'
                    type: str
                  instanceId:
                    description: It is the sda border device's instanceId.
                    returned: always
                    sample: 0
                    type: int
                  instanceTenantId:
                    description: It is the sda border device's instanceTenantId.
                    returned: always
                    sample: <instancetenantid>
                    type: str
                  instanceVersion:
                    description: It is the sda border device's instanceVersion.
                    returned: always
                    sample: 0
                    type: int
                  localIpAddress:
                    description: It is the sda border device's localIpAddress.
                    returned: always
                    sample: <localipaddress>
                    type: str
                  remoteIpAddress:
                    description: It is the sda border device's remoteIpAddress.
                    returned: always
                    sample: <remoteipaddress>
                    type: str
                  virtualNetwork:
                    contains:
                      idRef:
                        description: It is the sda border device's idRef.
                        returned: always
                        sample: <idref>
                        type: str
                    description: It is the sda border device's virtualNetwork.
                    returned: always
                    type: dict
                  vlanId:
                    description: It is the sda border device's vlanId.
                    returned: always
                    sample: 0
                    type: int
                description: It is the sda border device's l3Handoff.
                returned: always
                type: list
              policyPropagationEnabled:
                description: It is the sda border device's policyPropagationEnabled.
                returned: always
                sample: false
                type: bool
              policySgtTag:
                description: It is the sda border device's policySgtTag.
                returned: always
                sample: 0
                type: int
            description: It is the sda border device's extConnectivitySettings.
            returned: always
            type: list
          externalConnectivityIpPool:
            description: It is the sda border device's externalConnectivityIpPool.
            returned: always
            sample: <externalconnectivityippool>
            type: str
          externalDomainRoutingProtocol:
            description: It is the sda border device's externalDomainRoutingProtocol.
            returned: always
            sample: <externaldomainroutingprotocol>
            type: str
          id:
            description: It is the sda border device's id.
            returned: always
            sample: '478012'
            type: str
          instanceId:
            description: It is the sda border device's instanceId.
            returned: always
            sample: 0
            type: int
          instanceTenantId:
            description: It is the sda border device's instanceTenantId.
            returned: always
            sample: <instancetenantid>
            type: str
          instanceVersion:
            description: It is the sda border device's instanceVersion.
            returned: always
            sample: 0
            type: int
          internalDomainProtocolNumber:
            description: It is the sda border device's internalDomainProtocolNumber.
            returned: always
            sample: <internaldomainprotocolnumber>
            type: str
          memory:
            description: It is the sda border device's memory.
            returned: always
            sample: 0
            type: int
          nodeType:
            description: It is the sda border device's nodeType.
            returned: always
            type: list
          storage:
            description: It is the sda border device's storage.
            returned: always
            sample: 0
            type: int
        description: It is the sda border device's deviceSettings.
        returned: always
        type: dict
      displayName:
        description: It is the sda border device's displayName.
        returned: always
        sample: <displayname>
        type: str
      id:
        description: It is the sda border device's id.
        returned: always
        sample: '478012'
        type: str
      instanceId:
        description: It is the sda border device's instanceId.
        returned: always
        sample: 0
        type: int
      instanceTenantId:
        description: It is the sda border device's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      instanceVersion:
        description: It is the sda border device's instanceVersion.
        returned: always
        sample: 0
        type: int
      isSeeded:
        description: It is the sda border device's isSeeded.
        returned: always
        sample: false
        type: bool
      isStale:
        description: It is the sda border device's isStale.
        returned: always
        sample: false
        type: bool
      lastUpdateTime:
        description: It is the sda border device's lastUpdateTime.
        returned: always
        sample: 0
        type: int
      managedSites:
        description: It is the sda border device's managedSites.
        returned: always
        type: list
      name:
        description: It is the sda border device's name.
        returned: always
        sample: <name>
        type: str
      namespace:
        description: It is the sda border device's namespace.
        returned: always
        sample: <namespace>
        type: str
      networkDeviceId:
        description: It is the sda border device's networkDeviceId.
        returned: always
        sample: <networkdeviceid>
        type: str
      networkWideSettings:
        contains:
          aaa:
            description: It is the sda border device's aaa.
            returned: always
            type: list
          cmx:
            description: It is the sda border device's cmx.
            returned: always
            type: list
          deployPending:
            description: It is the sda border device's deployPending.
            returned: always
            sample: <deploypending>
            type: str
          dhcp:
            contains:
              id:
                description: It is the sda border device's id.
                returned: always
                sample: '478012'
                type: str
              ipAddress:
                contains:
                  address:
                    description: It is the sda border device's address.
                    returned: always
                    sample: <address>
                    type: str
                  addressType:
                    description: It is the sda border device's addressType.
                    returned: always
                    sample: <addresstype>
                    type: str
                  id:
                    description: It is the sda border device's id.
                    returned: always
                    sample: '478012'
                    type: str
                  paddedAddress:
                    description: It is the sda border device's paddedAddress.
                    returned: always
                    sample: <paddedaddress>
                    type: str
                description: It is the sda border device's ipAddress.
                returned: always
                type: dict
            description: It is the sda border device's dhcp.
            returned: always
            type: list
          displayName:
            description: It is the sda border device's displayName.
            returned: always
            sample: <displayname>
            type: str
          dns:
            contains:
              domainName:
                description: It is the sda border device's domainName.
                returned: always
                sample: <domainname>
                type: str
              id:
                description: It is the sda border device's id.
                returned: always
                sample: '478012'
                type: str
              ip:
                contains:
                  address:
                    description: It is the sda border device's address.
                    returned: always
                    sample: <address>
                    type: str
                  addressType:
                    description: It is the sda border device's addressType.
                    returned: always
                    sample: <addresstype>
                    type: str
                  id:
                    description: It is the sda border device's id.
                    returned: always
                    sample: '478012'
                    type: str
                  paddedAddress:
                    description: It is the sda border device's paddedAddress.
                    returned: always
                    sample: <paddedaddress>
                    type: str
                description: It is the sda border device's ip.
                returned: always
                type: dict
            description: It is the sda border device's dns.
            returned: always
            type: list
          id:
            description: It is the sda border device's id.
            returned: always
            sample: '478012'
            type: str
          instanceId:
            description: It is the sda border device's instanceId.
            returned: always
            sample: 0
            type: int
          instanceTenantId:
            description: It is the sda border device's instanceTenantId.
            returned: always
            sample: <instancetenantid>
            type: str
          instanceVersion:
            description: It is the sda border device's instanceVersion.
            returned: always
            sample: 0
            type: int
          ldap:
            description: It is the sda border device's ldap.
            returned: always
            type: list
          nativeVlan:
            description: It is the sda border device's nativeVlan.
            returned: always
            type: list
          netflow:
            description: It is the sda border device's netflow.
            returned: always
            type: list
          ntp:
            description: It is the sda border device's ntp.
            returned: always
            type: list
          snmp:
            description: It is the sda border device's snmp.
            returned: always
            type: list
          syslogs:
            description: It is the sda border device's syslogs.
            returned: always
            type: list
        description: It is the sda border device's networkWideSettings.
        returned: always
        type: dict
      otherDevice:
        description: It is the sda border device's otherDevice.
        returned: always
        type: list
      provisioningState:
        description: It is the sda border device's provisioningState.
        returned: always
        sample: <provisioningstate>
        type: str
      resourceVersion:
        description: It is the sda border device's resourceVersion.
        returned: always
        sample: 0
        type: int
      roles:
        description: It is the sda border device's roles.
        returned: always
        type: list
      saveWanConnectivityDetailsOnly:
        description: It is the sda border device's saveWanConnectivityDetailsOnly.
        returned: always
        sample: false
        type: bool
      siteId:
        description: It is the sda border device's siteId.
        returned: always
        sample: <siteid>
        type: str
      targetIdList:
        description: It is the sda border device's targetIdList.
        returned: always
        type: list
      transitNetworks:
        contains:
          idRef:
            description: It is the sda border device's idRef.
            returned: always
            sample: <idref>
            type: str
        description: It is the sda border device's transitNetworks.
        returned: always
        type: list
      type:
        description: It is the sda border device's type.
        returned: always
        sample: <type>
        type: str
      virtualNetwork:
        description: It is the sda border device's virtualNetwork.
        returned: always
        type: list
      wlan:
        description: It is the sda border device's wlan.
        returned: always
        type: list
    description: Payload, property of the response body.
    returned: always
    type: dict
  returned: always
  status:
    description: Status, property of the response body.
    returned: always
    sample: <status>
    type: str
  type: dict

See also