W3cubDocs

/Ansible

check_point.mgmt.cp_mgmt_put_file – put file on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.1.1).

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 check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_put_file.

New in version 2.9: of check_point.mgmt

Synopsis

  • put file on Check Point over Web Services API
  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
comments
string
Comments string.
file_content
string
N/A
file_name
string
N/A
file_path
string
N/A
targets
list / elements=string
On what targets to execute this command. Targets may be identified by their name, or object unique identifier.
version
string
Version of checkpoint. If not given one, the latest version taken.
wait_for_task
boolean
    Choices:
  • no
  • yes ←
Wait for the task to end. Such as publish task.
wait_for_task_timeout
integer
Default:
30
How many minutes to wait until throwing a timeout error.

Examples

- name: put-file
  cp_mgmt_put_file:
    file_content: 'vs ip 192.0.2.1
vs2 ip 192.0.2.2'
    file_name: vsx_conf
    file_path: /home/admin/
    targets:
    - corporate-gateway

Return Values

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

Key Returned Description
cp_mgmt_put_file
dictionary
always.
The checkpoint put-file output.


Authors

  • Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_put_file_module.html