ceph.ceph_admin.shell module

Interface to cephadm shell CLI.

class ceph.ceph_admin.shell.ShellMixin

Bases: object

Interface to shell CLI.

shell(args: List[str], base_cmd_args: Optional[Dict] = None, check_status: bool = True, timeout: int = 600, long_running: bool = False)

Ceph orchestrator shell interface to run ceph commands.

Parameters

  • args (List) – list arguments

  • base_cmd_args (Dict)) – cephadm base command options

  • check_status (Bool) – check command status

  • timeout (Int) – Maximum time allowed for execution.

  • long_running (Bool) – Long running command (default: False)

Returns

out (Str), err (Str) stdout and stderr response rc (Int) exit status code if long_running command