check_point.mgmt.cp_mgmt_add_data_center_object – Imports a Data Center Object from a Data Center Server. Data Center Object represents an object in the cloud environment.
check_point.mgmt.cp_mgmt_add_data_center_object – Imports a Data Center Object from a Data Center Server. Data Center Object represents an object in the cloud environment.
Note
This plugin is part of the check_point.mgmt collection (version 2.0.0).
To install it use: ansible-galaxy collection install check_point.mgmt
.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_add_data_center_object
.
New in version 2.9: of check_point.mgmt
Synopsis
- Imports a Data Center Object from a Data Center Server.
Data Center Object represents an object in the cloud environment, e.g. a virtual machine, cluster, network and more.
Use the show-data-center-content command to see the Data Center Objects that can be imported from a Data Center Server.
- All operations are performed over Web Services API.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
color string |
|
Color of the object. Should be one of existing colors. |
comments string |
Comments string. | |
data_center_name string |
Name of the Data Center Server the object is in. | |
data_center_uid string |
Unique identifier of the Data Center Server the object is in. | |
details_level string |
|
The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. |
groups list / elements=string |
Collection of group identifiers. | |
ignore_errors boolean |
|
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. |
ignore_warnings boolean |
|
Apply changes ignoring warnings. |
name string |
Override default name on data-center. | |
tags list / elements=string |
Collection of tag identifiers. | |
uid_in_data_center string |
Unique identifier of the object in the Data Center Server. | |
uri string |
URI of the object in the Data Center Server. | |
version string |
Version of checkpoint. If not given one, the latest version taken. | |
wait_for_task boolean |
|
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: add-data-center-object
cp_mgmt_add_data_center_object:
data_center_name: vCenter 1
name: VM1 mgmt name
state: present
uri: /Datacenters/VMs/My VM1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cp_mgmt_add_data_center_object dictionary |
always. |
The checkpoint add-data-center-object 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/2.11/collections/check_point/mgmt/cp_mgmt_add_data_center_object_module.html