cisco.dnac.backup_nfs_configurations module -- Resource module for Backup Nfs Configurations

Note

This module is part of the cisco.dnac collection (version 6.46.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations create and delete of the resource Backup Nfs Configurations.

  • This api is used to create NFS configuration.

  • This api is used to delete the NFS configuration.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

id

string

Id path parameter. The `id` of the NFS configuration to be deleted.Obtain the `id` from the id attribute in the response of the `/dna/system/api/v1/backupNfsConfigurations` API.

nfsPort

integer

NFS Port.

nfsVersion

string

NFS version.

portMapperPort

integer

NFS port mapper port.

server

string

NFS server host.

sourcePath

string

NFS server path.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are backup.Backup.create_n_f_s_configuration, backup.Backup.delete_n_f_s_configuration,

  • Paths used are post /dna/system/api/v1/backupNfsConfigurations, delete /dna/system/api/v1/backupNfsConfigurations/{id},

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Backup CreateNFSConfiguration

Complete reference of the CreateNFSConfiguration API.

Cisco DNA Center documentation for Backup DeleteNFSConfiguration

Complete reference of the DeleteNFSConfiguration API.

Examples

---
- name: Create
  cisco.dnac.backup_nfs_configurations:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    nfsPort: 0
    nfsVersion: string
    portMapperPort: 0
    server: string
    sourcePath: string
- name: Delete by id
  cisco.dnac.backup_nfs_configurations:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: absent
    id: string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"message": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)