cisco.radkit.service_info module – Retrieve RADKit service information and status

Note

This module is part of the cisco.radkit collection (version 2.0.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 git+https://wwwin-github.cisco.com/scdozier/cisco.radkit-ansible.git. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.radkit.service_info.

New in cisco.radkit 0.6.0

Synopsis

  • Tests connectivity to RADKit service and retrieves comprehensive service information

  • Provides service status, capabilities, inventory details, and security features

  • Useful for health checks, monitoring, and service discovery operations

  • Supports optional inventory and capability updates during information gathering

Requirements

The below requirements are needed on the host that executes this module.

  • cisco-radkit-client

Parameters

Parameter

Comments

client_ca_path

string

Alternate path to client ca cert for RADKIT If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_CLIENT_CA_PATH will be used instead.

client_cert_path

string

Alternate path to client cert for RADKIT If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_CLIENT_CERT_PATH will be used instead.

client_key_password_b64

aliases: radkit_client_private_key_password_base64

string / required

Client certificate password in base64 If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_CLIENT_PRIVATE_KEY_PASSWORD_BASE64 will be used instead.

client_key_path

string

Alternate path to client key for RADKIT If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_CLIENT_KEY_PATH will be used instead.

identity

aliases: radkit_identity

string / required

Identity to authentiate with RADKit (xxxx@cisco.com). If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_IDENTITY will be used instead.

ping

boolean

Send ping RPC messages to verify service connectivity and responsiveness

Useful as a liveness check for monitoring systems

Choices:

  • false

  • true ← (default)

service_serial

aliases: radkit_serial, radkit_service_serial

string / required

Radkit service serial If the value is not specified in the task, the value of environment variable RADKIT_ANSIBLE_SERVICE_SERIAL will be used instead.

update_capabilities

boolean

Update service capabilities information during the request

Capabilities may change after service upgrades or configuration changes

Automatically enabled when update_inventory is true

Choices:

  • false

  • true ← (default)

update_inventory

boolean

Refresh the device inventory for this service during information gathering

Also refreshes service capabilities as a side effect

May take additional time for services with large inventories

Choices:

  • false

  • true ← (default)

Examples

- name:  Get RADKit service info
  cisco.radkit.service_info:
    service_serial: abc-def-ghi
  register: service_info
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

capabilities

list / elements=string

List of capabilities of service

Returned: success

e2ee_active

boolean

Returns True E2EE is currently in use when communicating with this Service

Returned: success

e2ee_supported

boolean

Returns True if this Service supports end-to-end encryption (E2EE)

Returned: success

inventory_length

integer

Number of devices in inventory

Returned: success

service_id

string

The service ID / serial of service

Returned: success

status

string

Returns ‘up’ or ‘down’ depending on if the service is reachable

Returned: success

version

string

The version of service

Returned: success

Authors

  • Scott Dozier (@scdozier)