Try SpotterManage NfvProvision objects of SiteDesign
| "added in version" 1.0.0 of cisco.dnac"
Authors: Rafael Campos (@racampos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.dnac:==2.0.7
collections:
- name: cisco.dnac
version: 2.0.7Design and Provision single/multi NFV device with given site/area/building/floor .
Returns provisioning device information for the specified IP address.
- name: provision_nfv
cisco.dnac.nfv_provision:
state: create # required
provisioning: # required
- site: # required
siteProfileName: SomeValue # string
area:
name: SomeValue # string
parentName: SomeValue # string
building:
name: SomeValue # string
address: SomeValue # string
latitude: 1 # number
longitude: 1 # number
parentName: SomeValue # string
floor:
name: SomeValue # string
parentName: SomeValue # string
rfModel: SomeValue # string
width: 1 # number
length: 1 # number
height: 1 # number
device: # required
- tagName: SomeValue # string, required
serviceProviders: # required
- serviceProvider: SomeValue # string, required
wanInterface:
ipAddress: SomeValue # string
interfaceName: SomeValue # string
subnetmask: SomeValue # string
bandwidth: SomeValue # string
gateway: SomeValue # string
services: # required
- type: SomeValue # string, required
mode: SomeValue # string
systemIp: SomeValue # string
centralManagerIP: SomeValue # string
centralRegistrationKey: SomeValue # string
commonKey: SomeValue # string
adminPasswordHash: SomeValue # string
disk: SomeValue # string
subPools: # required
- type: SomeValue # string, required
name: SomeValue # string, required
ipSubnet: SomeValue # string, required
gateway: SomeValue # string, required
parentPoolName: SomeValue # string
ip: SomeValue # string
deviceSerialNumber: SomeValue # string
vlan:
- type: SomeValue # string, required
id: SomeValue # string, required
interfaces: SomeValue # string, required
network: SomeValue # string
customNetworks:
- name: SomeValue # string, required
port: SomeValue # string
ipAddressPool: SomeValue # string
templateParam:
nfvis:
var1: SomeValue # string
asav:
var1: SomeValue # string
siteProfile: # required
- siteProfileName: SomeValue # string, required
device: # required
- deviceType: SomeValue # string, required
tagName: SomeValue # string, required
serviceProviders: # required
- serviceProvider: SomeValue # string, required
linkType: SomeValue # string, required
connect: True # boolean, required
defaultGateway: True # boolean, required
dia: True # boolean, required
services: # required
- type: SomeValue # string, required
profile: SomeValue # string, required
name: SomeValue # string, required
imageName: SomeValue # string, required
topology: # required
type: SomeValue # string
name: SomeValue # string
assignIp: SomeValue # string
mode: SomeValue # string
customServices:
- name: SomeValue # string, required
applicationType: SomeValue # string, required
profile: SomeValue # string, required
topology: # required
type: SomeValue # string
name: SomeValue # string
assignIp: SomeValue # string
imageName: SomeValue # string
customNetworks:
- name: SomeValue # string, required
servicesToConnect: # required
- service: SomeValue # string, required
connectionType: SomeValue # string, required
networkMode: SomeValue # string, required
vlan: SomeValue # string
vlan:
- type: SomeValue # string, required
id: SomeValue # string, required
customTemplate:
- deviceType: SomeValue # string, required
template: SomeValue # string, required
- name: get_device_details_by_ip
cisco.dnac.nfv_provision:
state: query # required
device_ip: SomeValue # string, required
register: nm_get_device_details_by_ip
device_ip:
description:
- Device to which the provisioning detail has to be retrieved.
- Required for state query.
type: str
siteProfile:
description:
- Site Profile, property of the request body (list of objects).
- Required for state create.
elements: dict
suboptions:
device:
description:
- It is the nfv provision's device.
elements: dict
required: true
suboptions:
customNetworks:
description:
- It is the nfv provision's customNetworks.
elements: dict
suboptions:
connectionType:
description:
- It is the nfv provision's connectionType.
required: true
type: str
name:
description:
- It is the nfv provision's name.
required: true
type: str
networkMode:
description:
- It is the nfv provision's networkMode.
required: true
type: str
servicesToConnect:
description:
- It is the nfv provision's servicesToConnect.
elements: dict
required: true
suboptions:
service:
description:
- It is the nfv provision's service.
required: true
type: str
type: list
vlan:
description:
- It is the nfv provision's vlan.
type: str
type: list
customServices:
description:
- It is the nfv provision's customServices.
elements: dict
suboptions:
applicationType:
description:
- It is the nfv provision's applicationType.
required: true
type: str
imageName:
description:
- It is the nfv provision's imageName.
type: str
name:
description:
- It is the nfv provision's name.
required: true
type: str
profile:
description:
- It is the nfv provision's profile.
required: true
type: str
topology:
description:
- It is the nfv provision's topology.
required: true
suboptions:
assignIp:
description:
- It is the nfv provision's assignIp.
type: str
name:
description:
- It is the nfv provision's name.
type: str
type:
description:
- It is the nfv provision's type.
type: str
type: dict
type: list
customTemplate:
description:
- It is the nfv provision's customTemplate.
elements: dict
suboptions:
deviceType:
description:
- It is the nfv provision's deviceType.
required: true
type: str
template:
description:
- It is the nfv provision's template.
required: true
type: str
type: list
deviceType:
description:
- It is the nfv provision's deviceType.
required: true
type: str
dia:
description:
- It is the nfv provision's dia.
required: true
type: bool
serviceProviders:
description:
- It is the nfv provision's serviceProviders.
elements: dict
required: true
suboptions:
connect:
description:
- It is the nfv provision's connect.
required: true
type: bool
defaultGateway:
description:
- It is the nfv provision's defaultGateway.
required: true
type: bool
linkType:
description:
- It is the nfv provision's linkType.
required: true
type: str
serviceProvider:
description:
- It is the nfv provision's serviceProvider.
required: true
type: str
type: list
services:
description:
- It is the nfv provision's services.
elements: dict
required: true
suboptions:
imageName:
description:
- It is the nfv provision's imageName.
required: true
type: str
mode:
description:
- It is the nfv provision's mode.
type: str
name:
description:
- It is the nfv provision's name.
required: true
type: str
profile:
description:
- It is the nfv provision's profile.
required: true
type: str
topology:
description:
- It is the nfv provision's topology.
required: true
suboptions:
assignIp:
description:
- It is the nfv provision's assignIp.
type: str
name:
description:
- It is the nfv provision's name.
type: str
type:
description:
- It is the nfv provision's type.
type: str
type: dict
type:
description:
- It is the nfv provision's type.
required: true
type: str
type: list
tagName:
description:
- It is the nfv provision's tagName.
required: true
type: str
vlan:
description:
- It is the nfv provision's vlan.
elements: dict
suboptions:
id:
description:
- It is the nfv provision's id.
required: true
type: str
type:
description:
- It is the nfv provision's type.
required: true
type: str
type: list
type: list
siteProfileName:
description:
- It is the nfv provision's siteProfileName.
required: true
type: str
type: list
provisioning:
description:
- Provisioning, property of the request body (list of objects).
- Required for state create.
elements: dict
suboptions:
device:
description:
- It is the nfv provision's device.
elements: dict
required: true
suboptions:
customNetworks:
description:
- It is the nfv provision's customNetworks.
elements: dict
suboptions:
ipAddressPool:
description:
- It is the nfv provision's ipAddressPool.
type: str
name:
description:
- It is the nfv provision's name.
required: true
type: str
port:
description:
- It is the nfv provision's port.
type: str
type: list
deviceSerialNumber:
description:
- It is the nfv provision's deviceSerialNumber.
type: str
ip:
description:
- It is the nfv provision's ip.
type: str
serviceProviders:
description:
- It is the nfv provision's serviceProviders.
elements: dict
required: true
suboptions:
serviceProvider:
description:
- It is the nfv provision's serviceProvider.
required: true
type: str
wanInterface:
description:
- It is the nfv provision's wanInterface.
suboptions:
bandwidth:
description:
- It is the nfv provision's bandwidth.
type: str
gateway:
description:
- It is the nfv provision's gateway.
type: str
interfaceName:
description:
- It is the nfv provision's interfaceName.
type: str
ipAddress:
description:
- It is the nfv provision's ipAddress.
type: str
subnetmask:
description:
- It is the nfv provision's subnetmask.
type: str
type: dict
type: list
services:
description:
- It is the nfv provision's services.
elements: dict
required: true
suboptions:
adminPasswordHash:
description:
- It is the nfv provision's adminPasswordHash.
type: str
centralManagerIP:
description:
- It is the nfv provision's centralManagerIP.
type: str
centralRegistrationKey:
description:
- It is the nfv provision's centralRegistrationKey.
type: str
commonKey:
description:
- It is the nfv provision's commonKey.
type: str
disk:
description:
- It is the nfv provision's disk.
type: str
mode:
description:
- It is the nfv provision's mode.
type: str
systemIp:
description:
- It is the nfv provision's systemIp.
type: str
type:
description:
- It is the nfv provision's type.
required: true
type: str
type: list
subPools:
description:
- It is the nfv provision's subPools.
elements: dict
required: true
suboptions:
gateway:
description:
- It is the nfv provision's gateway.
required: true
type: str
ipSubnet:
description:
- It is the nfv provision's ipSubnet.
required: true
type: str
name:
description:
- It is the nfv provision's name.
required: true
type: str
parentPoolName:
description:
- It is the nfv provision's parentPoolName.
type: str
type:
description:
- It is the nfv provision's type.
required: true
type: str
type: list
tagName:
description:
- It is the nfv provision's tagName.
required: true
type: str
templateParam:
description:
- It is the nfv provision's templateParam.
suboptions:
asav:
description:
- It is the nfv provision's asav.
suboptions:
var1:
description:
- It is the nfv provision's var1.
type: str
type: dict
nfvis:
description:
- It is the nfv provision's nfvis.
suboptions:
var1:
description:
- It is the nfv provision's var1.
type: str
type: dict
type: dict
vlan:
description:
- It is the nfv provision's vlan.
elements: dict
suboptions:
id:
description:
- It is the nfv provision's id.
required: true
type: str
interfaces:
description:
- It is the nfv provision's interfaces.
required: true
type: str
network:
description:
- It is the nfv provision's network.
type: str
type:
description:
- It is the nfv provision's type.
required: true
type: str
type: list
type: list
site:
description:
- It is the nfv provision's site.
required: true
suboptions:
area:
description:
- It is the nfv provision's area.
suboptions:
name:
description:
- It is the nfv provision's name.
type: str
parentName:
description:
- It is the nfv provision's parentName.
type: str
type: dict
building:
description:
- It is the nfv provision's building.
suboptions:
address:
description:
- It is the nfv provision's address.
type: str
latitude:
description:
- It is the nfv provision's latitude.
type: int
longitude:
description:
- It is the nfv provision's longitude.
type: int
name:
description:
- It is the nfv provision's name.
type: str
parentName:
description:
- It is the nfv provision's parentName.
type: str
type: dict
floor:
description:
- It is the nfv provision's floor.
suboptions:
height:
description:
- It is the nfv provision's height.
type: int
length:
description:
- It is the nfv provision's length.
type: int
name:
description:
- It is the nfv provision's name.
type: str
parentName:
description:
- It is the nfv provision's parentName.
type: str
rfModel:
description:
- It is the nfv provision's rfModel.
type: str
width:
description:
- It is the nfv provision's width.
type: int
type: dict
siteProfileName:
description:
- It is the nfv provision's siteProfileName.
type: str
type: dict
type: list
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: site_design.get_device_details_by_ip
type: str