Базовые комманды (cmd)

Apt

carnival.cmd.apt.force_install(pkgname, version=None, update=False, hide=False)

Install apt package

carnival.cmd.apt.get_installed_version(pkgname: str) → Optional[str]

Get installed package version Returns None if package not installed

carnival.cmd.apt.get_pkg_versions(pkgname: str) → List[str]

carnival.cmd.apt.install(pkgname, version=None, update=True, hide=False) → bool

Install apt package if not installed Returns true if installed, false if was already installed

carnival.cmd.apt.install_multiple(*pkg_names, update=True, hide=False) → bool

carnival.cmd.apt.is_pkg_installed(pkgname: str, version=None) → bool

Check is package installed? If version not specified - check any version

carnival.cmd.apt.remove(*pkg_names, hide=False)

Cli

carnival.cmd.cli.pty(command: str, **kwargs) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f6ebefc87b8>

carnival.cmd.cli.run(command: str, **kwargs) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f6ebefc87b8>

Filesystem

carnival.cmd.fs.ensure_dir_exists(path, user=None, group=None, mode=None) → None

carnival.cmd.fs.is_dir_exists(dir_path: str) → bool

carnival.cmd.fs.is_file_contains(filename, text, exact=False, escape=True) → bool

carnival.cmd.fs.is_file_exists(path) → bool

carnival.cmd.fs.mkdirs(*dirs)

System

carnival.cmd.system.get_current_user_id() → int

carnival.cmd.system.get_current_user_name() → str

carnival.cmd.system.is_current_user_root() → bool

carnival.cmd.system.set_password(username: str, password: str)

carnival.cmd.system.ssh_authorized_keys_add(ssh_key: str, keys_file='.ssh/authorized_keys')

carnival.cmd.system.ssh_authorized_keys_ensure(*ssh_keys) → None

carnival.cmd.system.ssh_authorized_keys_list() → List[str]

carnival.cmd.system.ssh_copy_id(pubkey_file='~/.ssh/id_rsa.pub') → None

Systemd

carnival.cmd.systemd.daemon_reload()

carnival.cmd.systemd.disable(service_name: str, reload_daemon=False, stop_now=True)

carnival.cmd.systemd.enable(service_name: str, reload_daemon=False, start_now=True)

carnival.cmd.systemd.restart(service_name: str)

carnival.cmd.systemd.start(service_name: str, reload_daemon=False)

carnival.cmd.systemd.stop(service_name: str, reload_daemon=False)

Transfer

carnival.cmd.transfer.get(remote: str, local: str, preserve_mode: bool = True) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f6ebefce828>

carnival.cmd.transfer.put(local: str, remote: str, preserve_mode: bool = True) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f6ebefce828>

carnival.cmd.transfer.put_template(template_path: str, remote: str, **context) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f6ebefce828>

carnival.cmd.transfer.rsync(source, target, exclude=(), delete=False, strict_host_keys=True, rsync_opts='--progress -pthrvz', ssh_opts='')