cp_mgmt_session_facts
Get session objects facts on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_session_facts
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get session objects facts on Check Point 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. | ||
| filter | str | Search expression to filter objects by. The provided text should be exactly the same as it would be given in SmartConsole Object Explorer. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. The search involves both a IP search and a textual search in name, comment, tags etc. Available from R81 JHF management version. | ||
| limit | int | No more than that many results will be returned. This parameter is relevant only for getting few objects. | ||
| offset | int | Skip that many results before beginning to return them. This parameter is relevant only for getting few objects. | ||
| order | list | Sorts results by the given field. By default the results are sorted in the descending order by the session publish time. This parameter is relevant only for getting few objects. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| view_published_sessions | bool | Show a list of published sessions. Available from R80.10 management version. |
Example
yaml
- name: show-session
check_point.mgmt.cp_mgmt_session_facts: {}
- name: show-sessions
check_point.mgmt.cp_mgmt_session_facts:
details_level: standard
limit: 50
offset: 0