cisco.dnac.nfv_provision – Manage NfvProvision objects of SiteDesign

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.nfv_provision.

New in version 1.0.0: of cisco.dnac

Synopsis

• Design and Provision single/multi NFV device with given site/area/building/floor .

• Returns provisioning device information for the specified IP address.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter					Choices/Defaults	Comments
device_ip string						Device to which the provisioning detail has to be retrieved. Required for state query.
provisioning list / elements=dictionary						Provisioning, property of the request body (list of objects). Required for state create.
	device list / elements=dictionary / required					It is the nfv provision's device.
		customNetworks list / elements=dictionary				It is the nfv provision's customNetworks.
			ipAddressPool string			It is the nfv provision's ipAddressPool.
			name string / required			It is the nfv provision's name.
			port string			It is the nfv provision's port.
		deviceSerialNumber string				It is the nfv provision's deviceSerialNumber.
		ip string				It is the nfv provision's ip.
		serviceProviders list / elements=dictionary / required				It is the nfv provision's serviceProviders.
			serviceProvider string / required			It is the nfv provision's serviceProvider.
			wanInterface dictionary			It is the nfv provision's wanInterface.
				bandwidth string		It is the nfv provision's bandwidth.
				gateway string		It is the nfv provision's gateway.
				interfaceName string		It is the nfv provision's interfaceName.
				ipAddress string		It is the nfv provision's ipAddress.
				subnetmask string		It is the nfv provision's subnetmask.
		services list / elements=dictionary / required				It is the nfv provision's services.
			adminPasswordHash string			It is the nfv provision's adminPasswordHash.
			centralManagerIP string			It is the nfv provision's centralManagerIP.
			centralRegistrationKey string			It is the nfv provision's centralRegistrationKey.
			commonKey string			It is the nfv provision's commonKey.
			disk string			It is the nfv provision's disk.
			mode string			It is the nfv provision's mode.
			systemIp string			It is the nfv provision's systemIp.
			type string / required			It is the nfv provision's type.
		subPools list / elements=dictionary / required				It is the nfv provision's subPools.
			gateway string / required			It is the nfv provision's gateway.
			ipSubnet string / required			It is the nfv provision's ipSubnet.
			name string / required			It is the nfv provision's name.
			parentPoolName string			It is the nfv provision's parentPoolName.
			type string / required			It is the nfv provision's type.
		tagName string / required				It is the nfv provision's tagName.
		templateParam dictionary				It is the nfv provision's templateParam.
			asav dictionary			It is the nfv provision's asav.
				var1 string		It is the nfv provision's var1.
			nfvis dictionary			It is the nfv provision's nfvis.
				var1 string		It is the nfv provision's var1.
		vlan list / elements=dictionary				It is the nfv provision's vlan.
			id string / required			It is the nfv provision's id.
			interfaces string / required			It is the nfv provision's interfaces.
			network string			It is the nfv provision's network.
			type string / required			It is the nfv provision's type.
	site dictionary / required					It is the nfv provision's site.
		area dictionary				It is the nfv provision's area.
			name string			It is the nfv provision's name.
			parentName string			It is the nfv provision's parentName.
		building dictionary				It is the nfv provision's building.
			address string			It is the nfv provision's address.
			latitude integer			It is the nfv provision's latitude.
			longitude integer			It is the nfv provision's longitude.
			name string			It is the nfv provision's name.
			parentName string			It is the nfv provision's parentName.
		floor dictionary				It is the nfv provision's floor.
			height integer			It is the nfv provision's height.
			length integer			It is the nfv provision's length.
			name string			It is the nfv provision's name.
			parentName string			It is the nfv provision's parentName.
			rfModel string			It is the nfv provision's rfModel.
			width integer			It is the nfv provision's width.
		siteProfileName string				It is the nfv provision's siteProfileName.
siteProfile list / elements=dictionary						Site Profile, property of the request body (list of objects). Required for state create.
	device list / elements=dictionary / required					It is the nfv provision's device.
		customNetworks list / elements=dictionary				It is the nfv provision's customNetworks.
			connectionType string / required			It is the nfv provision's connectionType.
			name string / required			It is the nfv provision's name.
			networkMode string / required			It is the nfv provision's networkMode.
			servicesToConnect list / elements=dictionary / required			It is the nfv provision's servicesToConnect.
				service string / required		It is the nfv provision's service.
			vlan string			It is the nfv provision's vlan.
		customServices list / elements=dictionary				It is the nfv provision's customServices.
			applicationType string / required			It is the nfv provision's applicationType.
			imageName string			It is the nfv provision's imageName.
			name string / required			It is the nfv provision's name.
			profile string / required			It is the nfv provision's profile.
			topology dictionary / required			It is the nfv provision's topology.
				assignIp string		It is the nfv provision's assignIp.
				name string		It is the nfv provision's name.
				type string		It is the nfv provision's type.
		customTemplate list / elements=dictionary				It is the nfv provision's customTemplate.
			deviceType string / required			It is the nfv provision's deviceType.
			template string / required			It is the nfv provision's template.
		deviceType string / required				It is the nfv provision's deviceType.
		dia boolean / required			Choices: no yes	It is the nfv provision's dia.
		serviceProviders list / elements=dictionary / required				It is the nfv provision's serviceProviders.
			connect boolean / required		Choices: no yes	It is the nfv provision's connect.
			defaultGateway boolean / required		Choices: no yes	It is the nfv provision's defaultGateway.
			linkType string / required			It is the nfv provision's linkType.
			serviceProvider string / required			It is the nfv provision's serviceProvider.
		services list / elements=dictionary / required				It is the nfv provision's services.
			imageName string / required			It is the nfv provision's imageName.
			mode string			It is the nfv provision's mode.
			name string / required			It is the nfv provision's name.
			profile string / required			It is the nfv provision's profile.
			topology dictionary / required			It is the nfv provision's topology.
				assignIp string		It is the nfv provision's assignIp.
				name string		It is the nfv provision's name.
				type string		It is the nfv provision's type.
			type string / required			It is the nfv provision's type.
		tagName string / required				It is the nfv provision's tagName.
		vlan list / elements=dictionary				It is the nfv provision's vlan.
			id string / required			It is the nfv provision's id.
			type string / required			It is the nfv provision's type.
	siteProfileName string / required					It is the nfv provision's siteProfileName.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.nfv_provision

The official documentation on the cisco.dnac.plugins.module_utils.definitions.nfv_provision module.

NfvProvision reference

Complete reference of the NfvProvision object model.

NfvProvision reference

SDK reference.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: site_design.get_device_details_by_ip

Authors

• Rafael Campos (@racampos)