cp_mgmt_interface_facts
Get interface objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_interface_facts
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get interface objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| details_level | str | 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. | ||
| domains_to_process | list | Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. | ||
| filter | str | Filter interfaces by name or IP address. | ||
| gateway_uid | str | Gateway or cluster object uid that the interfaces belongs to. | ||
| limit | int | The maximal number of returned results. This parameter is relevant only for getting few objects. | ||
| name | str | Network interface name. | ||
| offset | int | Number of the results to initially skip. This parameter is relevant only for getting few objects. | ||
| order | list | Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. This parameter is relevant only for getting few objects. | ||
| show_membership | bool | Indicates whether to calculate and show “groups” field for every object in reply. | ||
| version | str | Management API version path; omitted uses the default API version. |
Example
yaml
- name: show-interface
check_point.mgmt.cp_mgmt_interface_facts:
name: eth0
gateway_uid: ff918e85-98c4-4b17-bcac-417aab863d87
- name: show-interfaces
check_point.mgmt.cp_mgmt_interface_facts:
details_level: full
gateway_uid: ff918e85-98c4-4b17-bcac-417aab863d87
limit: 50
offset: 0