f5os_tenant_console_enable – Manage tenant-console user access on F5 devices via RESTCONF/OpenApi

New in version 1.17.0.

Synopsis

  • It Handles enabling and locking tenant-console user accounts on F5 devices.
  • It can either enable or lock the tenant-consol user account.
  • When using the status as enabled, it opens up the console access.
  • When using the status as locked, it closes the console access.
  • The module uses two states, enabled and locked, to manage the status of the expiry feature.

Parameters

Parameter Choices/Defaults Configuration Comments
console_user_password
string
Password for the tenant-console user.
If specified, then tenant-console user password will be set with provided password value.
The password will be changed to the specified value during the initial configuration of the tenant-console user
role
string
Default:
"tenant-console"
Role of the tenant user to be used, value of role will be always tenant-console
state
string
    Choices:
  • enabled ←
  • locked
Desired state of the tenant-console user.
If enabled, provides the ability to access the tenant-console user using SSH.
If locked, access to tenant-console disabled.
tenant_username
string / required
Username of the tenant-console to enable access. It is name of tenant created on the partition/appliance.

Examples

- name: Create a tenant-console user with expiry enabled
  f5os_tenant_console_enable:
    tenant_username: "example_user"
    role: "tenant-console"
    state: "enabled"

- name: Lock a tenant-console user
  f5os_tenant_console_enable:
    tenant_username: "example_user"
    role: "tenant-console"
    state: "locked"

Return Values

The following are the fields unique to this module:

Key Returned Description
changed
boolean
always
Whether any changes were made to the tenant-console configuration.
expiry_status
string
always
The expiry status of the user after the operation.

Sample:
enabled
role
string
always
The role assigned to the tenant-console user.

Sample:
tenant-console
tenant_username
string
always
The username of the tenant-console user that was configured.

Sample:
example_user


Status

Authors

  • Ravinder Reddy (@chinthalapalli)