purestorage.flasharray.purefa_file module – Manage FlashArray File Copies
Note
This module is part of the purestorage.flasharray collection (version 1.43.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 purestorage.flasharray.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: purestorage.flasharray.purefa_file.
New in purestorage.flasharray 1.22.0
Synopsis
Copy FlashArray File from one filesystem to another
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
FlashArray API token for admin privileged user. |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Disable insecure certificate warnings in debug logs Choices:
|
|
FlashArray management IPv4 address or Hostname. |
|
A pre-signed JWT to authenticate with, as an alternative to api_token. The token is exchanged by the array for a short-lived access token. Requires a matching API Client to be registered on the array (see purestorage.flasharray.purefa_apiclient). |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
Define whether to overwrite an existing target file Choices:
|
|
Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token. Requires client_id, key_id, issuer and username. |
|
Password protecting private_key_file, if encrypted. |
|
Name of the source managed directory containing the source file to be copied |
|
Name of the file to copy Include full path from the perspective of the source managed directory |
|
Name of the target managed directory containing the source file to be copied If not provided will use managed directory specified by source_dir |
|
Name of the file to copy to Include full path from the perspective of the target managed directory If not provided the file will be copied to the relative path specified by name |
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
Notes
Note
This module requires the
purestorageandpy-pure-clientPython libraries.Additional Python libraries may be required for specific modules.
You must set
PUREFA_URLandPUREFA_APIenvironment variables if fa_url and api_token arguments are not passed to the module directly.Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flasharray.purefa_apiclient.
Examples
- name: Copy a file from dir foo to dir bar
purestorage.flasharray.purefa_file:
source_file: "/directory1/file1"
source_dir: "fs1:root"
target_file: "/diff_dir/file1"
target_dir: "fs1:root"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Copy a file in a directory to the same directory with a different name
purestorage.flasharray.purefa_file:
source_file: "/directory1/file1"
source_dir: "fs1:root"
target_file: "/directory_1/file2"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Copy a file in a directory to an existing file with overwrite
purestorage.flasharray.purefa_file:
source_file: "/directory1/file1"
source_dir: "fs1:root"
target_file: "/diff_dir/file1"
target_dir: "fs2:root"
overwrite: true
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592