chef-server-ctl

chef-server-ctl: command (subcommand)

General Commands:-

Main Commands subcommand Description
chef-server-ctl backup Backup the Chef Server
chef-server-ctl cleanse Delete *all* Chef Server data, and start from scratch.
chef-server-ctl cleanup Perform post-upgrade removal of now-obsolete data, configuration files, logs, etc. Add the '--no-op' flag to see what *would* be removed.
chef-server-ctl gather-logs Create a tarball of recent logs and system information for Chef Support
chef-server-ctl help Print this help message.
chef-server-ctl install Install addon package by name, with optional --path parameter indicating directory containing packages
chef-server-ctl rebuild-migration-state Attempt to rebuild the migration-state file before upgrade.
chef-server-ctl reconfigure Reconfigure the application
chef-server-ctl reindex Reindex all server data for a given organization
chef-server-ctl restore Restore the Chef Server from backup
chef-server-ctl show-config Show the configuration that would be generated by reconfigure.
chef-server-ctl test Run the API test suite against localhost.
chef-server-ctl uninstall Kill all processes and uninstall the process supervisor (data will be preserved).
chef-server-ctl upgrade Upgrade your private chef installation.

Service Management Commands:-

Main Commands subcommand Description
chef-server-ctl graceful-kill Attempt a graceful stop, then SIGKILL the entire process group.
chef-server-ctl hup Send the services a HUP.
chef-server-ctl int Send the services an INT.
chef-server-ctl kill Send the services a KILL.
chef-server-ctl once Start the services if they are down. Do not restart them if they stop.
chef-server-ctl restart Stop the services if they are running, then start them again.
chef-server-ctl service-list List all the services (enabled services appear with a *.)
chef-server-ctl start Start services if they are down, and restart them if they stop.
chef-server-ctl status Show the status of all the services.
chef-server-ctl stop Stop the services, and do not restart them.
chef-server-ctl tail Watch the service logs of all enabled services.
chef-server-ctl term Send the services a TERM.
chef-server-ctl usr1 Send the services a USR1.
chef-server-ctl usr2 Send the services a USR2.

Open Source Upgrade Commands:-

Main Commands subcommand Description
chef-server-ctl chef12-upgrade-data-transform Transfrom data from an open source Chef 11 server for upload to an Chef 12 server.
chef-server-ctl chef12-upgrade-download Download data from a open source Chef 11 server.
chef-server-ctl chef12-upgrade-upload Upload transformed open source Chef 11 data to a Chef 12 server.

Cleanup Commands:-

Main Commands subcommand Description
chef-server-ctl cleanup-bifrost Cleanup orphaned bifrost objects.

Debug Tools Commands:-

Main Commands subcommand Description
chef-server-ctl filtered-dump Generate a filtered dump of indexable Chef Objects for all organizations. Top-level data is captured; only object name is captured from object json

High Availability Commands:-

Main Commands subcommand Description
chef-server-ctl backup-recover Set this server to HA backup state, ignoring VRRP
chef-server-ctl ha-status Show the status of high availability services.
chef-server-ctl master-recover Set this server to HA master state, ignoring VRRP.

Key Rotation Commands:-

Main Commands subcommand Description
chef-server-ctl add-client-key Create a new client key
chef-server-ctl add-user-key Create a new user key
chef-server-ctl delete-client-key Create a new user key
chef-server-ctl delete-user-key Delete a key
chef-server-ctl list-client-keys List keys for a client
chef-server-ctl list-user-keys List keys for a user

Secrets Management Commands:-

Main Commands subcommand Description
chef-server-ctl oc-id-show-app Show configuration for oc-id applications.
chef-server-ctl remove-secret Remove secret NAME of GROUP
chef-server-ctl require-credential-rotation Disable the Chef Server and require credential rotation
chef-server-ctl rotate-all-credentials Rotate all Chef Server service credentials
chef-server-ctl rotate-credentials Rotate Chef Server credentials for a given service
chef-server-ctl rotate-shared-secrets Rotate the Chef Server shared secrets and all service credentials
chef-server-ctl set-actions-password Add or change the rabbitmq actions queue password
chef-server-ctl set-db-superuser-password Add or change DB superuser password
chef-server-ctl set-secret Set or change secret NAME of GROUP
chef-server-ctl show-secret Show the value of the given secret in the secret store
chef-server-ctl show-service-credentials Show the service credentials

Organization And User Management Commands:-

Main Commands subcommand Description
chef-server-ctl org-create Create an organization in the chef server.
chef-server-ctl org-delete Delete an organization in the chef server.
chef-server-ctl org-list List all organizations in the chef server.
chef-server-ctl org-show Show an organization in the chef server.
chef-server-ctl org-user-add Associate a user with an organization.
chef-server-ctl org-user-remove Dissociate a user with an organization.
chef-server-ctl password Set a user's password or System Recovery Password.
chef-server-ctl user-create Set a user's password or System Recovery Password.
chef-server-ctl user-delete Delete a user in the chef server.
chef-server-ctl user-edit Edit a user in the chef server.
chef-server-ctl user-list List all users in the chef server.
chef-server-ctl user-show Show a user in the chef server.

 

Database Commands:-

Main Commands subcommand Description
chef-server-ctl psql Launches an interactive psql session with the service database you name. Add '--write' for write access and '--options <OPTIONS>' to specify psql options.

 

Server Admins Commands:-

Main Commands subcommand Description
chef-server-ctl grant-server-admin-permissions Grant a user the ability to create other users by added the user to the server-admins group.
chef-server-ctl list-server-admins List users that have server-admins permissions.
chef-server-ctl remove-server-admin-permissions Remove all special permission granted to a user from being a server-admin.

 


  Call us on +91 700 483 5930   |   +91 700 483 5706     Contact@DevopsSchool.com