cp_mgmt_radius_server
Manages radius-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_radius_server
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages radius-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| accounting | dict | Accounting settings. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| 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. | ||
| groups | list | Collection of group identifiers. | ||
| ignore_errors | bool | 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 | bool | Apply changes ignoring warnings. | ||
| name | str | yes | Object name. | |
| priority | int | The priority of the RADIUS Server in case it is a member of a RADIUS Group. | ||
| protocol | str | The type of authentication protocol that will be used when authenticating the user to the RADIUS server. | ||
| server | str | The UID or Name of the host that is the RADIUS Server. | ||
| server_version | str | The version can be either RADIUS Version 1.0, which is RFC 2138 compliant, and RADIUS Version 2.0 which is RFC 2865 compliant. | ||
| service | str | The UID or Name of the Service to which the RADIUS server listens. | ||
| shared_secret | str | The secret between the RADIUS server and the Security Gateway. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-radius-server
check_point.mgmt.cp_mgmt_radius_server:
name: radServer
server: hostRad
shared_secret: '123'
state: present
- name: set-radius-server
check_point.mgmt.cp_mgmt_radius_server:
name: t4
server: hostRadius
state: present
- name: delete-radius-server
check_point.mgmt.cp_mgmt_radius_server:
ignore_warnings: 'true'
name: radiusServer
state: absent