ripclawffb.helix_core.helix_core_license_info module – Get server license information from Perforce Helix Core
Note
This module is part of the ripclawffb.helix_core collection (version 1.3.0).
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 ripclawffb.helix_core.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ripclawffb.helix_core.helix_core_license_info.
New in ripclawffb.helix_core 1.3.0
Synopsis
Retrieves server licensing information from Perforce Helix Core.
Returns the details of the active license and its usage limits.
This is a read-only module that does not make any changes.
Requirements
The below requirements are needed on the host that executes this module.
P4Python pip module is required
Parameters
Parameter |
Comments |
|---|---|
Character set used for translation of unicode files Can also use ‘P4CHARSET’ environment variable Default: |
|
The login password Can also use ‘P4PASSWD’ environment variable |
|
The hostname/ip and port of the server (perforce:1666) Can also use ‘P4PORT’ environment variable |
|
A user with access to perform this operation Can also use ‘P4USER’ environment variable |
See Also
See also
- Helix Core License
Manage server license
- P4Python Pip Module
Python module to interact with Helix Core
Examples
# Get license info
- name: Get license info
ripclawffb.helix_core.helix_core_license_info:
server: '1666'
user: bruno
charset: auto
password: ''
register: license_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Always False as this is a read-only module. Returned: always Sample: |
|
A dict with the current license details. Contains usage info if the server supports it and the user has admin or super privileges. Returned: success |