Console Commands - Admin#
The command format is:
bin/znuny.Console.pl <COMMAND> <OPTIONS>
Use the option -h or –help to get more information about a specific command.
Command |
Version |
Description |
|---|---|---|
Admin::Article::StorageSwitch |
pre-Znuny |
Migrate article files from one storage backend to another on the fly. |
Admin::CommunicationChannel::Drop |
pre-Znuny |
Drop a communication channel (with its data) that is no longer available in the system. |
Admin::CommunicationChannel::Sync |
pre-Znuny |
Synchronize registered communication channels in the system. |
Admin::Config::ExportModifiedSettings |
7.1 |
Export all modified settings to a file. |
Admin::Config::FixInvalid |
pre-Znuny |
Attempt to fix invalid system configuration settings. |
Admin::Config::FixMissingFrontendFiles |
6.1 |
Fixes missing JavaScript and CSS configurations between Znuny upgrades. |
Admin::Config::ListInvalid |
pre-Znuny |
List invalid system configuration. |
Admin::Config::Read |
pre-Znuny |
Gather the value of a setting. |
Admin::Config::UnlockAll |
pre-Znuny |
Unlock all settings. |
Admin::Config::Update |
pre-Znuny |
Update the value of a setting. |
Admin::CustomerCompany::Add |
pre-Znuny |
Add a customer company. |
Admin::CustomerUser::Add |
pre-Znuny |
Add a customer user. |
Admin::CustomerUser::SetPassword |
pre-Znuny |
Update the password for a customer user. |
Admin::DBCRUD::AddUUIDColumns |
6.3 |
Adds a UUID column (if missing) to every database table of a DBCRUD module. |
Admin::DBCRUD::MigrateUUIDColumns |
6.3 |
Migrates UUID columns for every database table of a DBCRUD module for Znuny 6.1 and up. |
Admin::DynamicField::DefaultColumnsScreenConfig |
6.1 |
Adds and removes dynamic fields to/from default column screen configurations. |
Admin::DynamicField::Export |
6.1 |
Exports configuration of all dynamic fields. Output can be formatted as YAML or Perl structure. |
Admin::DynamicField::Import |
7.0 |
Imports configuration of dynamic fields and dynamic field screens from a file in YAML format. |
Admin::DynamicField::ScreenConfig |
6.1 |
Adds and removes dynamic fields to/from screen configurations. |
Admin::Group::Add |
pre-Znuny |
Create a new group. |
Admin::Group::CustomerLink |
pre-Znuny |
Connect a customer user to a group. |
Admin::Group::RoleLink |
pre-Znuny |
Connect a role to a group. |
Admin::Group::UserLink |
pre-Znuny |
Connect a user to a group. |
Admin::OAuth2TokenManagement::ExportTokenConfig |
6.3 |
Exports OAuth2 token configuration in YAML format. |
Admin::OAuth2TokenManagement::GenerateAuthorizationCodeRequestURL |
6.3 |
Generates a URL to request an authorization code for an OAuth 2 token (AuthorizationCode flow only). |
Admin::OAuth2TokenManagement::ImportTokenConfig |
6.3 |
Imports an OAuth2 token configuration from a YAML file. |
Admin::OAuth2TokenManagement::ListTokenInformation |
6.3 |
Lists OAuth2 token information. |
Admin::OAuth2TokenManagement::RequestTokenByClientCredentials |
6.3 |
Requests a token using client credentials (ClientCredentials auth flow only). |
Admin::OAuth2TokenManagement::RequestTokenByRefreshToken |
6.3 |
Requests a token using a refresh token (AuthorizationCode auth flow only). |
Admin::Object::Export |
7.2 |
Export specified objects. |
Admin::Object::Import |
7.2 |
Import specified objects. |
Admin::Package::Export |
pre-Znuny |
Export the content of a package to a directory. |
Admin::Package::FileSearch |
pre-Znuny |
Find a file in an installed package. |
Admin::Package::Install |
pre-Znuny |
Install a package. |
Admin::Package::List |
pre-Znuny |
List all installed packages. |
Admin::Package::ListInstalledFiles |
pre-Znuny |
List all installed package files. |
Admin::Package::Reinstall |
pre-Znuny |
Reinstall a package. |
Admin::Package::ReinstallAll |
pre-Znuny |
Reinstall all packages that are not correctly deployed. |
Admin::Package::RepositoryList |
pre-Znuny |
Lists all known package repositories. |
Admin::Package::Uninstall |
pre-Znuny |
Uninstall a package. |
Admin::Package::Upgrade |
pre-Znuny |
Upgrade a package. |
Admin::Package::UpgradeAll |
pre-Znuny |
Upgrade all packages to the latest versions from the online repositories. |
Admin::Queue::Add |
pre-Znuny |
Create a new queue. |
Admin::Queue::List |
pre-Znuny |
List existing queues. |
Admin::Role::Add |
pre-Znuny |
Create a new role. |
Admin::Role::UserLink |
pre-Znuny |
Connect a user to a role. |
Admin::Service::Add |
pre-Znuny |
Add a new service. |
Admin::StandardTemplate::QueueLink |
pre-Znuny |
Link a template to a queue. |
Admin::SystemAddress::Add |
pre-Znuny |
Add a new system address. |
Admin::TicketAttributeRelations::Import |
6.2 |
Imports ticket attribute relations from a CSV/Excel file. |
Admin::TicketType::Add |
pre-Znuny |
Add a new ticket type. |
Admin::Translation::Export |
7.2 |
Export translations to a file. |
Admin::Translation::Import |
7.2 |
Import translations from a file. |
Admin::User::Add |
pre-Znuny |
Add a user. |
Admin::User::MigratePreferencesBackend |
7.1 |
Migrates user preferences from source backend to destination backend. |
Admin::User::SetPassword |
pre-Znuny |
Update the password for an agent. |
Admin::WebService::Add |
pre-Znuny |
Create a new web service. |
Admin::WebService::Delete |
pre-Znuny |
Delete an existing web service. |
Admin::WebService::Dump |
pre-Znuny |
Print a web service configuration (YAML format) into a file. |
Admin::WebService::List |
pre-Znuny |
List all web services. |
Admin::WebService::Update |
pre-Znuny |
Update an existing web service. |