cisco.catalystcenter.event_sftp_configurations module -- Resource module for Event Sftp Configurations

Note

This module is part of the cisco.catalystcenter collection (version 2.12.0).

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

To use it in a playbook, specify: cisco.catalystcenter.event_sftp_configurations.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create and update of the resource Event Sftp Configurations.

• Adds a new SFTP configuration. Returns the created configuration on success.

• Updates the SFTP configuration identified by the provided ID.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
description string	Description of the SFTP configuration.
host string	Hostname or IP address of the SFTP server.
id string	Id path parameter. Unique identifier for the SFTP configuration to update.
name string	Name of the SFTP configuration.
password string	Password for SFTP authentication.
path string	Path on the SFTP server where files will be uploaded.
port string	Port number for the SFTP server.
username string	Username for SFTP authentication.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are event_management.EventManagement.create_a_new_sftp_configuration, event_management.EventManagement.update_an_existing_sftp_configuration,

• Paths used are post /dna/intent/api/v1/event/sftp/configurations, put /dna/intent/api/v1/event/sftp/configurations/{id},

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Event Management CreateANewSFTPConfiguration

Complete reference of the CreateANewSFTPConfiguration API.

Cisco Catalyst Center documentation for Event Management UpdateAnExistingSFTPConfiguration

Complete reference of the UpdateAnExistingSFTPConfiguration API.

Examples

---
- name: Create
  cisco.catalystcenter.event_sftp_configurations:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    description: string
    host: string
    name: string
    password: string
    path: string
    port: string
    username: string
- name: Update by id
  cisco.catalystcenter.event_sftp_configurations:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    description: string
    host: string
    id: string
    name: string
    password: string
    path: string
    port: string
    username: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"description": "string", "host": "string", "name": "string", "path": "string", "port": "string", "sftpId": "string", "username": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)