Server Maintenance Commands

certificates

The cfy certificates commands handle certificates’ maintenance procedures. Commands Replacing Certificates Certificates are used by Studio Conductor for TLS based secure communication between the different Studio Conductor components and between the user interface and the Conductor Manager. Certificates are set during the initial deployment of the Conductor Manager (cluster or all-in-one), but later maintenance and replacement of the certificates may be required as a result of regulatory compliance demand, certificate expiration, or revocation due to security breach.

cluster

The cfy cluster command is used to manage the Conductor Manager cluster. Optional flags These commands support the common CLI flags. Commands Status Usage cfy cluster status [OPTIONS] Display the current status of the Conductor Manager cluster Example $ cfy cluster status Retrieving Cloudify cluster status... [ip=10.239.1.160] Current cluster status is OK: Cluster status services: +--------------------------------+----------+ | service | status | +--------------------------------+----------+ | manager | OK | | db | OK | | broker | OK | +--------------------------------+----------+ Detailed status For a JSON formatted detailed cluster status use cfy cluster status --json

config

The cfy config command is used to manage the Conductor Manager’s configuration. Optional flags cfy config commands support the common CLI flags. Commands List Usage cfy config list [OPTIONS] List all configurations Example $ cfy config list Config: +-----------------------------------+--------------------------------------------------+------------+------------+-------------+ | name | value | scope | updated_at | is_editable | +-----------------------------------+--------------------------------------------------+------------+------------+-------------+ | account_lock_period | -1 | rest | | True | | broker_port | 5671 | agent | | True | | blueprint_folder_max_files | 10000 | rest | | True | | blueprint_folder_max_size_mb | 50 | rest | | True | | default_page_size | 1000 | rest | | True | | failed_logins_before_account_lock | 4 | rest | | True | | file_server_root | /opt/manager/resources | rest | | False | | file_server_url | https://172.

init

The cfy init command is used to initialize a Studio Conductor working directory. Before you can use cfy, you must initialize a working directory for it, in which relevant functional information will be stored. Running cfy intall or cfy profiles use initializes an environment automatically. Usage cfy init [OPTIONS] [BLUEPRINT_PATH] Initialize a Studio Conductor environment. This is required to perform many actions and should be the first action performed after installing Studio Conductor.

ldap

The cfy ldap command is used to set LDAP authentication to enable you to integrate your LDAP users and groups with Studio Conductor. Optional flags These commands support the common CLI flags. Commands set Usage cfy LDAP set [OPTIONS] Set the Conductor Manager to use the LDAP authenticator. Required flags -s, --ldap-server TEXT - The LDAP address against which to authenticate, for example: ldaps://ldap.domain.com. -u, --ldap-username TEXT- The LDAP admin username to be set on the Conductor Manager.

license

The cfy license command is used to manage the Conductor Manager license. Optional flags cfy license commands support the common CLI flags. Commands Upload Usage cfy license upload [OPTIONS] <license-path> Upload a Studio Conductor license to a Manager. Example $ cfy license upload license.yaml ... Uploading Studio Conductor License `conductor_license.yaml` to the Manager... Cloudify license successfully uploaded. ... list Usage cfy license list [OPTIONS] List details of the Studio Conductor license.

profiles

The cfy profiles command is used to manage the Studio Conductor profiles. Each profile can have its own credentials for managers and Studio Conductor various environmental settings Optional flags These commands support the common CLI flags. Commands list Usage cfy profiles list [OPTIONS] List all profiles.   Example $ cfy profiles list ... Listing all profiles... Profiles: +---------------+--------------+----------+-------------------------------------+----------+-----------+---------------+------------------+----------------+-----------------+ | name | manager_ip | ssh_user | ssh_key_path | ssh_port | rest_port | rest_protocol | manager_username | manager_tenant | bootstrap_state | +---------------+--------------+----------+-------------------------------------+----------+-----------+---------------+------------------+----------------+-----------------+ | *10.

sites

The cfy sites command is used to manage sites and their location in Conductor Manager. Optional flags cfy sites commands support the common CLI flags. Commands List Usage cfy sites list [OPTIONS] List all sites Optional flags --sort-by TEXT - Key for sorting the list. --descending - Sort list in descending order. [default: False] -t, --tenant-name TEXT - The name of the tenant from which to list the sites.

snapshots

The cfy snapshots command is used to manage data snapshots of the Conductor Manager. You must have admin credentials to create and restore snapshots. You can use the command to create, upload, download, delete and list snapshots and also to restore a Manager using a snapshot archive. For more about working with snapshots, go to: snapshots. Optional flags These commands support the common CLI flags. Commands create Usage cfy snapshots create [OPTIONS] [SNAPSHOT_ID]

ssh

The cfy ssh command is used to connect to a Conductor Manager via SSH. You can use the command to create a new terminal session, run a command, or connect to a shared tmux-based session. Usage cfy ssh [OPTIONS] Connects to a running manager via SSH. host starts a tmux session (e.g. tmux new -s “ssh_session_vi120m”) after which a command for a client is printed in the tmux session for the host to send to the client (i.

tenants

The cfy tenants command is used to create and manage tenants on the Conductor Manager. You can run commands on a tenant other than the one that you are logged into by specifying the name of the tenant to which the command applies. For example, cfy tenants add-user USERNAME -t TENANT_NAME can be used to add a user to a different tenant. Requirements To use the command you must have Studio Conductor sys_admin credentials.

user-groups

The cfy user-groups command is used to define and manage user groups on the Conductor Manager. To use the command you must have Studio Conductor admin credentials. If your Conductor Manager is integrated with LDAP/AD. ensure that the group names that you define exactly match those defined in LDAP. Requirements To use the command you must have Studio Conductor admin credentials. User names and passwords must conform to the following requirements:

users

The cfy users command is used to manage users and passwords on the Conductor Manager. If you choose not to integrate the Conductor Manager with LDAP-based user management system, you must add each user individually with a unique username and a password. You can also create user groups and add users to them. The users and user groups can be assigned to one or more tenants, with different roles in each tenant.