hitachivantara.vspone_block.vsp.hv_upload_file module – This uploads the files required to set the transfer destination of audit log files

Note

This module is part of the hitachivantara.vspone_block collection (version 4.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

To use it in a playbook, specify: hitachivantara.vspone_block.vsp.hv_upload_file.

New in hitachivantara.vspone_block 4.0.0

Synopsis

• This module uploads files required to set the transfer destination of audit log files.

• For example usage, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/upload_file.yml

Requirements

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

• python >= 3.8

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
api_token string	Token used to operate on locked resources.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary / required	Specification to upload file.
file_path string / required	Path to the file to be uploaded.
file_type string / required	Type of the file to be uploaded. Choices: "primary_client" "primary_root" "secondary_client" "secondary_root"

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Notes

Note

• Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Enable SNMP agent and configure SNMPv2c with trap destinations
  hitachivantara.vspone_block.vsp.hv_upload_file:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret
    spec:
      file_path: /path/to/audit_log_file.pem
      file_type: primary_client

Return Values

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

Key	Description
result dictionary	Dictionary containing the outcome of the module execution. Returned: always
changed boolean	Indicates whether any change was made. Returned: always Sample: false
failed boolean	Indicates whether the module execution failed. Returned: always Sample: false
message list / elements=string	Human-readable message(s) about the operation result. Returned: always Sample: ["", "Transfer destination for audit log file specified successfully."]

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)