ceph.ceph_admin.ls module

Module that interfaces with ceph orch ls CLI.

class ceph.ceph_admin.ls.LSMixin

Bases: object

CLI that list known services to orchestrator.

ls(config: Optional[Dict] = None) → Tuple

Execute the command ceph orch ls <args>.

Parameters

config (Dict) – The key/value pairs passed from the test case.

Returns

output (Str), error (Str) returned by the command.

Example:

Testing ceph orch ls

config:
    command: ls
    base_cmd_args:
        verbose: true
        format: json | json-pretty | xml | xml-pretty | plain | yaml
    args:
        host: <hostname>
        service_type: <type of service>
        service_name: <name of the service>
        export: true
        refresh: true