f5os_primarykey – Manage F5OS Devices Primary-key Setting.

New in version 1.11.0.

Synopsis

  • Manage Setting system primary-key using passphrase and salt on F5OS Devices.

Parameters

Parameter Choices/Defaults Configuration Comments
force_update
boolean
added in 1.13.0
    Choices:
  • no ←
  • yes
Force update the primary key on F5OS Device.
passphrase
string / required
Specifies Passphrase for generating primary key.
salt
string / required
Specifies Salt for generating primary key.
state
string
    Choices:
  • present ←
  • absent
Primary key on F5OS Device state.
If present, Creates/Set the Primary key on F5OS Device.

Notes

Note

  • This module does not support deleting the primary key.

Examples

- name: Setting Primary Key on F5OS Device
  f5os_primarykey:
    passphrase: "test-passphrase"
    salt: "test-salt"
    state: present

- name: Update Primary Key on F5OS Device
  f5os_primarykey:
    passphrase: "test-passphrase"
    salt: "test-salt"
    state: present
    force_update: true

Return Values

The following are the fields unique to this module:

Key Returned Description
passphrase
string
changed
Specifies Passphrase for generating primary key.

Sample:
test-passphrase
salt
string
changed
Specifies Salt for generating primary key.

Sample:
test-salt


Status

Authors

  • Ravinder Reddy (@chinthalapalli)