Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
activation-key Manipulate activation keys.
xxxxxarchitecture Manipulate architectures
auth Foreman connection login/logout.
xxxxxcapsule Manipulate capsule
xxxxxcompute-resource Manipulate compute resources.
xxxxxconsole Launch a pry session in Hammer.
content-host manipulate content hosts on the server
xxxxxcontent-view Manipulate content views.
xxxxxdomain Manipulate domains.
xxxxxenvironment Manipulate environments.
erratum Manipulate errata
xxxxxfact Search facts.
filter Manage permission filters.
full-help Recursive help of all hammer commands
global-parameter Manipulate global parameters.
xxxxxgpg manipulate GPG Key actions on the server
xxxxxhost Manipulate hosts.
host-collection Manipulate host collections
xxxxxhostgroup Manipulate hostgroups.
xxxxxlifecycle-environment manipulate lifecycle_environments on the server
location Manipulate locations.
xxxxxmedium Manipulate installation media.
xxxxxmodel Manipulate hardware models.
organization Manipulate organizations
xxxxxos Manipulate operating system.
package Manipulate packages.
package-group Manipulate package groups
xxxxxpartition-table Manipulate partition tables.
ping get the status of the server
product Manipulate products.
xxxxxproxy Manipulate smart proxies.
xxxxxpuppet-class Search puppet modules.
xxxxxpuppet-module View Puppet Module details.
xxxxxreport Browse and read reports.
repository Manipulate repositories
repository-set manipulate repository sets on the server
role Manage user roles.
xxxxxsc-param Manipulate smart class parameters.
shell Interactive shell
xxxxxsubnet Manipulate subnets.
subscription Manipulate subscriptions.
sync-plan Manipulate sync plans
task Tasks related actions.
xxxxxtemplate Manipulate config templates.
user Manipulate users.
user-group Manage user groups.
Options:
--autocomplete LINE Get list of possible endings
--csv Output as CSV (same as --output=csv)
--csv-separator SEPARATOR Character to separate the values
--interactive INTERACTIVE Explicitly turn interactive mode on/off
One of true/false, yes/no, 1/0.
--output ADAPTER Set output format. One of [base, table, silent, csv]
--show-ids Show ids of associated resources
--version show version
-c, --config CFG_FILE path to custom config file
-d, --debug show debugging output
-h, --help print help
-p, --password PASSWORD password to access the remote system
-s, --server SERVER remote system address
-u, --username USERNAME username to access the remote system
-v, --verbose be verbose
Manipulate activation keys.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
add-host-collection Associate a resource
add-subscription Add subscription
create Create an activation key
delete Destroy an activation key
host-collections List associated host collections
info Show an activation key
list List activation keys
remove-host-collection Disassociate a resource
remove-subscription Remove subscription
subscriptions List associated subscriptions
update Update an activation key
Options:
-h, --help print help
Associate a resource
Usage:
[OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Add subscription
Usage:
[OPTIONS]
Options:
--id ID resource ID
--quantity QUANTITY subscription quantity
--subscription-id ID subscription ID
-h, --help print help
Create an activation key
Usage:
[OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--description DESCRIPTION description
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-content-hosts MAX_CONTENT_HOSTS maximum number of registered content hosts
--name NAME name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--unlimited-content-hosts UNLIMITED_CONTENT_HOSTS can the activation key have unlimited content hosts
One of true/false, yes/no, 1/0.
-h, --help print help
Destroy an activation key
Usage:
[OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List associated host collections
Usage:
[OPTIONS]
Options:
--id ID resource ID
-h, --help print help
Show an activation key
Usage:
[OPTIONS]
Options:
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List activation keys
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
--content-view CONTENT_VIEW_NAME Content view name
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME activation key name to filter by
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help print help
Disassociate a resource
Usage:
[OPTIONS]
Options:
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
--id ID ID of the activation key
--name NAME Activation key name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Remove subscription
Usage:
[OPTIONS]
Options:
--id ID resource ID
--subscription-id ID subscription ID
-h, --help print help
List associated subscriptions
Usage:
[OPTIONS]
Options:
--id ID resource ID
-h, --help print help
Update an activation key
Usage:
[OPTIONS]
Options:
--content-view CONTENT_VIEW_NAME Content view name
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--description DESCRIPTION description
--id ID ID of the activation key
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--max-content-hosts MAX_CONTENT_HOSTS maximum number of registered content hosts
--name NAME Activation key name to search by
--new-name NEW_NAME name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--release-version RELEASE_VERSION content release version
--service-level SERVICE_LEVEL service level
--unlimited-content-hosts UNLIMITED_CONTENT_HOSTS can the activation key have unlimited content hosts
One of true/false, yes/no, 1/0.
-h, --help print help
Foreman connection login/logout.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
login Set credentials
logout Wipe your credentials
status Information about current connections
Options:
-h, --help print help
Set credentials
Usage:
[OPTIONS]
Options:
-h, --help print help
Wipe your credentials
Usage:
[OPTIONS]
Options:
-h, --help print help
Information about current connections
Usage:
[OPTIONS]
Options:
-h, --help print help
manipulate content hosts on the server
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
create Register a content host
delete Unregister a content host
errata Manage errata on your content hosts
info Show a content host
list List content hosts
- xxxxx
package Manage packages on your content hosts
- xxxxx
package-group Manage package-groups on your content hosts
tasks
update Update content host information
Options:
-h, --help print help
Register a content host
Usage:
[OPTIONS]
Options:
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--description DESCRIPTION Description of the content host
--guest-ids GUEST_IDS IDs of the virtual guests running on this content host
Comma separated list of values.
--host-collection-ids HOST_COLLECTION_IDS Specify the host collections as an array
Comma separated list of values.
--last-checkin LAST_CHECKIN Last check-in time of this content host
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--location LOCATION Physical location of the content host
--name NAME Name of the content host
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--release-ver RELEASE_VER Release version of the content host
--service-level SERVICE_LEVEL A service level for auto-healing process, e.g. SELF-SUPPORT
-h, --help print help
Unregister a content host
Usage:
[OPTIONS]
Options:
--id ID ID of the content host
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Manage errata on your content hosts
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
- xxxxx
apply Schedule errata for installation
info Retrieve a single errata for a system
Options:
-h, --help print help
Retrieve a single errata for a system
Usage:
[OPTIONS]
Options:
--content-host CONTENT_HOST_NAME Name to search by
--content-host-id CONTENT_HOST_ID UUID of the content host
--id ID Errata id of the erratum (RHSA-2012:108)
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Show a content host
Usage:
[OPTIONS]
Options:
--id ID ID of the content host
--name NAME Name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List content hosts
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--host-collection HOST_COLLECTION_NAME Host collection name to search by
--host-collection-id HOST_COLLECTION_ID Id of the host collection
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME Filter content host by name
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--pool-id POOL_ID Filter content host by subscribed pool
--search SEARCH Search string
--uuid UUID Filter content host by uuid
-h, --help print help
Usage:
[OPTIONS]
Options:
--id ID ID of the content host
-h, --help print help
Update content host information
Usage:
[OPTIONS]
Options:
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--description DESCRIPTION Description of the content host
--guest-ids GUEST_IDS IDs of the virtual guests running on this content host
Comma separated list of values.
--host-collection-ids HOST_COLLECTION_IDS Specify the host collections as an array
Comma separated list of values.
--id ID ID of the content host
--last-checkin LAST_CHECKIN Last check-in time of this content host
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--location LOCATION Physical location of the content host
--name NAME Name to search by
--new-name NEW_NAME Name of the content host
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--release-ver RELEASE_VER Release version of the content host
--service-level SERVICE_LEVEL A service level for auto-healing process, e.g. SELF-SUPPORT
-h, --help print help
Manipulate errata
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
info Show an erratum
list List errata
Options:
-h, --help print help
Show an erratum
Usage:
[OPTIONS]
Options:
--id ID an erratum identifier
--name NAME Name to search by
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
-h, --help print help
List errata
Usage:
[OPTIONS]
Options:
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
- xxxxx
--content-view-filter-id CONTENT_VIEW_FILTER_ID filter identifier
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
- xxxxx
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
- xxxxx
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
-h, --help print help
Manage permission filters.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
available-permissions List all permissions
available-resources List available resource types.
create Create a filter
delete Delete a filter
info Show a filter
list List all filters
update Update a filter
Options:
-h, --help print help
List all permissions
Usage:
[OPTIONS]
Options:
--name NAME
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--resource-type RESOURCE_TYPE
-h, --help print help
List available resource types.
Usage:
[OPTIONS]
Options:
-h, --help print help
Create a filter
Usage:
[OPTIONS]
Options:
--location-ids LOCATION_IDS Comma separated list of values.
--organization-ids ORGANIZATION_IDS Comma separated list of values.
--permission-ids PERMISSION_IDS Comma separated list of values.
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help print help
Delete a filter
Usage:
[OPTIONS]
Options:
--id ID
-h, --help print help
Show a filter
Usage:
[OPTIONS]
Options:
--id ID
-h, --help print help
List all filters
Usage:
[OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
-h, --help print help
Update a filter
Usage:
[OPTIONS]
Options:
--id ID
--location-ids LOCATION_IDS Comma separated list of values.
--organization-ids ORGANIZATION_IDS Comma separated list of values.
--permission-ids PERMISSION_IDS Comma separated list of values.
--role ROLE_NAME User role name
--role-id ROLE_ID
--search SEARCH
-h, --help print help
Recursive help of all hammer commands
Usage:
[OPTIONS]
Options:
-h, --help print help
Manipulate global parameters.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
delete Delete a global parameter
list List all global parameters.
set Set a global parameter.
Options:
-h, --help print help
Delete a global parameter
Usage:
[OPTIONS]
Options:
--name NAME Common parameter name
-h, --help print help
List all global parameters.
Usage:
[OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
-h, --help print help
Set a global parameter.
Usage:
[OPTIONS]
Options:
--name NAME parameter name
--value VALUE parameter value
-h, --help print help
Manipulate host collections
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
add-content-host Add content host to the host collection
content-hosts List content hosts in the host collection
copy Make copy of a host collection
create Create a host collection
delete Destroy a host collection
info Show a host collection
list List host collections
remove-content-host Remove content hosts from the host collection
update Update a host collection
Options:
-h, --help print help
Add content host to the host collection
Usage:
[OPTIONS]
Options:
--content-host-ids CONTENT_HOST_IDS Array of content host ids
Comma separated list of values.
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List content hosts in the host collection
Usage:
[OPTIONS]
Options:
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Make copy of a host collection
Usage:
[OPTIONS]
Options:
--id ID ID of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Create a host collection
Usage:
[OPTIONS]
Options:
--content-host-ids CONTENT_HOST_IDS List of content host uuids to be in the host collection
Comma separated list of values.
--description DESCRIPTION
--host-collection-ids HOST_COLLECTION_IDS Array of content host ids to replace the content hosts in host collection
Comma separated list of values.
--max-content-hosts MAX_CONTENT_HOSTS Maximum number of content hosts in the host collection
--name NAME Host Collection name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--unlimited-content-hosts UNLIMITED_CONTENT_HOSTS Whether or not the host collection may have unlimited content hosts
One of true/false, yes/no, 1/0.
-h, --help print help
Destroy a host collection
Usage:
[OPTIONS]
Options:
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Show a host collection
Usage:
[OPTIONS]
Options:
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List host collections
Usage:
[OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID ID of the activation key
--by BY Field to sort the results on
--content-host CONTENT_HOST_NAME Name to search by
--content-host-id CONTENT_HOST_ID UUID of the content host
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME host collection name to filter by
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help print help
Remove content hosts from the host collection
Usage:
[OPTIONS]
Options:
--content-host-ids CONTENT_HOST_IDS Array of content host ids
Comma separated list of values.
--id ID Id of the host collection
--name NAME Host collection name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Update a host collection
Usage:
[OPTIONS]
Options:
--content-host-ids CONTENT_HOST_IDS List of content host uuids to be in the host collection
Comma separated list of values.
--description DESCRIPTION
--host-collection-ids HOST_COLLECTION_IDS Array of content host ids to replace the content hosts in host collection
Comma separated list of values.
--id ID Id of the host collection
--max-content-hosts MAX_CONTENT_HOSTS Maximum number of content hosts in the host collection
--name NAME Host collection name to search by
--new-name NEW_NAME Host Collection name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--unlimited-content-hosts UNLIMITED_CONTENT_HOSTS Whether or not the host collection may have unlimited content hosts
One of true/false, yes/no, 1/0.
-h, --help print help
Manipulate locations.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
- xxxxx
add-compute-resource Associate a compute resource
- xxxxx
add-config-template Associate a configuration template
- xxxxx
add-domain Associate a domain
- xxxxx
add-environment Associate an environment
- xxxxx
add-hostgroup Associate a hostgroup
- xxxxx
add-medium Associate a medium
add-organization Associate an organization
- xxxxx
add-smart-proxy Associate a smart proxy
- xxxxx
add-subnet Associate a subnet
add-user Associate an user
create Create a location
delete Delete a location
info Show a location
list List all locations
- xxxxx
remove-compute-resource Disassociate a compute resource
- xxxxx
remove-config-template Disassociate a configuration template
- xxxxx
remove-domain Disassociate a domain
- xxxxx
remove-environment Disassociate an environment
- xxxxx
remove-hostgroup Disassociate a hostgroup
- xxxxx
remove-medium Disassociate a medium
remove-organization Disassociate an organization
- xxxxx
remove-smart-proxy Disassociate a smart proxy
- xxxxx
remove-subnet Disassociate a subnet
remove-user Disassociate an user
update Update a location
Options:
-h, --help print help
Associate an organization
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Location name
--organization ORGANIZATION_NAME Organization name
--organization-id ORGANIZATION_ID organization ID
-h, --help print help
Associate an user
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Location name
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Create a location
Usage:
[OPTIONS]
Options:
- xxxxx
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values.
- xxxxx
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values.
- xxxxx
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values.
- xxxxx
--environment-ids ENVIRONMENT_IDS Environment IDs
Comma separated list of values.
- xxxxx
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values.
- xxxxx
--media-ids MEDIA_IDS Media IDs
Comma separated list of values.
--name NAME
- xxxxx
--realm-ids REALM_IDS Realm IDs
Comma separated list of values.
- xxxxx
--smart-proxy-ids SMART_PROXY_IDS Smart proxy IDs
Comma separated list of values.
- xxxxx
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values.
--user-ids USER_IDS User IDs
Comma separated list of values.
-h, --help print help
Delete a location
Usage:
[OPTIONS]
Options:
--id ID Location numeric id to search by
--name NAME Organization name
-h, --help print help
Show a location
Usage:
[OPTIONS]
Options:
--id ID Location numeric id to search by
--name NAME Organization name
-h, --help print help
List all locations
Usage:
[OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
-h, --help print help
Disassociate an organization
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Location name
--organization ORGANIZATION_NAME Organization name
--organization-id ORGANIZATION_ID organization ID
-h, --help print help
Disassociate an user
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Location name
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Update a location
Usage:
[OPTIONS]
Options:
- xxxxx
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values.
- xxxxx
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values.
- xxxxx
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values.
- xxxxx
--environment-ids ENVIRONMENT_IDS Environment IDs
Comma separated list of values.
- xxxxx
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values.
--id ID Location numeric id to search by
- xxxxx
--media-ids MEDIA_IDS Media IDs
Comma separated list of values.
--name NAME
--new-name NEW_NAME
- xxxxx
--realm-ids REALM_IDS Realm IDs
Comma separated list of values.
- xxxxx
--smart-proxy-ids SMART_PROXY_IDS Smart proxy IDs
Comma separated list of values.
- xxxxx
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values.
--user-ids USER_IDS User IDs
Comma separated list of values.
-h, --help print help
Manipulate organizations
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
- xxxxx
add-compute-resource Associate a compute resource
- xxxxx
add-config-template Associate a configuration template
- xxxxx
add-domain Associate a domain
- xxxxx
add-environment Associate an environment
- xxxxx
add-hostgroup Associate a hostgroup
- xxxxx
add-medium Associate a medium
- xxxxx
add-smart-proxy Associate a smart proxy
- xxxxx
add-subnet Associate a subnet
add-user Associate an user
create Create organization
delete Delete an organization
info Show organization
list List all organizations
- xxxxx
remove-compute-resource Disassociate a compute resource
- xxxxx
remove-config-template Disassociate a configuration template
- xxxxx
remove-domain Disassociate a domain
- xxxxx
remove-environment Disassociate an environment
- xxxxx
remove-hostgroup Disassociate a hostgroup
- xxxxx
remove-medium Disassociate a medium
- xxxxx
remove-smart-proxy Disassociate a smart proxy
- xxxxx
remove-subnet Disassociate a subnet
remove-user Disassociate an user
update Update organization
Options:
-h, --help print help
Associate an user
Usage:
[OPTIONS]
Options:
--id ID organization ID
--name NAME Organization name
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Create organization
Usage:
[OPTIONS]
Options:
- xxxxx
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values.
- xxxxx
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values.
--description DESCRIPTION description
- xxxxx
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values.
- xxxxx
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values.
--label LABEL unique label
- xxxxx
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment IDs
Comma separated list of values.
- xxxxx
--media-ids MEDIA_IDS Media IDs
Comma separated list of values.
--name NAME name
- xxxxx
--realm-ids REALM_IDS Realm IDs
Comma separated list of values.
- xxxxx
--smart-proxy-ids SMART_PROXY_IDS Smart proxy IDs
Comma separated list of values.
- xxxxx
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values.
--user-ids USER_IDS User IDs
Comma separated list of values.
-h, --help print help
Delete an organization
Usage:
[OPTIONS]
Options:
--async Do not wait for the task
--id ID
--label LABEL Organization label to search by
--name NAME Organization name
-h, --help print help
Show organization
Usage:
[OPTIONS]
Options:
--id ID
--label LABEL Organization label to search by
--name NAME Organization name
-h, --help print help
List all organizations
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. ‘name DESC’
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help print help
Disassociate an user
Usage:
[OPTIONS]
Options:
--id ID organization ID
--name NAME Organization name
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Update organization
Usage:
[OPTIONS]
Options:
- xxxxx
--compute-resource-ids COMPUTE_RESOURCE_IDS Compute resource IDs
Comma separated list of values.
- xxxxx
--config-template-ids CONFIG_TEMPLATE_IDS Provisioning template IDs
Comma separated list of values.
--description DESCRIPTION description of the organization
- xxxxx
--domain-ids DOMAIN_IDS Domain IDs
Comma separated list of values.
- xxxxx
--environment-ids ENVIRONMENT_IDS Environment IDs
Comma separated list of values.
- xxxxx
--hostgroup-ids HOSTGROUP_IDS Host group IDs
Comma separated list of values.
--id ID
--label LABEL Organization label to search by
- xxxxx
--lifecycle-environment-ids LIFECYCLE_ENVIRONMENT_IDS Environment IDs
Comma separated list of values.
- xxxxx
--media-ids MEDIA_IDS Media IDs
Comma separated list of values.
--name NAME Organization name
--new-name NEW_NAME
- xxxxx
--realm-ids REALM_IDS Realm IDs
Comma separated list of values.
--redhat-repository-url REDHAT_REPOSITORY_URL Redhat CDN url
- xxxxx
--smart-proxy-ids SMART_PROXY_IDS Smart proxy IDs
Comma separated list of values.
- xxxxx
--subnet-ids SUBNET_IDS Subnet IDs
Comma separated list of values.
--user-ids USER_IDS User IDs
Comma separated list of values.
-h, --help print help
Manipulate packages.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
info Show a package
list List packages
Options:
-h, --help print help
Show a package
Usage:
[OPTIONS]
Options:
--id ID a package identifier
--name NAME Name to search by
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
-h, --help print help
List packages
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
- xxxxx
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
- xxxxx
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
--search SEARCH Search string
-h, --help print help
Manipulate package groups
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
info Show a package group
list List package_groups
Options:
-h, --help print help
Show a package group
Usage:
[OPTIONS]
Options:
--id ID a package group identifier
--name NAME Name to search by
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
-h, --help print help
List package_groups
Usage:
[OPTIONS]
Options:
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-filter CONTENT_VIEW_FILTER_NAME Name to search by
- xxxxx
--content-view-filter-id CONTENT_VIEW_FILTER_ID filter identifier
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
- xxxxx
--content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
- xxxxx
--content-view-version-id CONTENT_VIEW_VERSION_ID Content view version identifier
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--repository REPOSITORY_NAME Repository name to search by
--repository-id REPOSITORY_ID repository ID
-h, --help print help
get the status of the server
Usage:
[OPTIONS]
Options:
-h, --help print help
Manipulate products.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
create Create a product
delete Destroy a product
info Show a product
list List products
remove-sync-plan Delete assignment sync plan and product.
set-sync-plan Assign sync plan to product.
update Updates a product
Options:
-h, --help print help
Create a product
Usage:
[OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID gpg key numeric identifier
--label LABEL
--name NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric identifier
-h, --help print help
Destroy a product
Usage:
[OPTIONS]
Options:
--id ID product numeric identifier
--name NAME Product name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Show a product
Usage:
[OPTIONS]
Options:
--id ID product numeric identifier
--name NAME Product name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List products
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
--custom CUSTOM Filter products by custom
One of true/false, yes/no, 1/0.
--enabled ENABLED Filter products by enabled or disabled
One of true/false, yes/no, 1/0.
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--name NAME Filter products by name
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
--subscription SUBSCRIPTION_NAME Subscription name to search by
--subscription-id SUBSCRIPTION_ID Subscription identifier
-h, --help print help
Delete assignment sync plan and product.
Usage:
[OPTIONS]
Options:
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID gpg key numeric identifier
--id ID product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric identifier
-h, --help print help
Assign sync plan to product.
Usage:
[OPTIONS]
Options:
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID gpg key numeric identifier
--id ID product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric identifier
-h, --help print help
Updates a product
Usage:
[OPTIONS]
Options:
--description DESCRIPTION Product description
--gpg-key GPG_KEY_NAME Name to search by
--gpg-key-id GPG_KEY_ID gpg key numeric identifier
--id ID product numeric identifier
--name NAME Product name to search by
--new-name NEW_NAME Product name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-plan SYNC_PLAN_NAME Sync plan name to search by
--sync-plan-id SYNC_PLAN_ID sync plan numeric identifier
-h, --help print help
Manipulate repositories
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
- xxxxx
create Create a custom repository
- xxxxx
delete Destroy a custom repository
info Show a custom repository
list List of enabled repositories
synchronize Sync a repository
- xxxxx
update Update a custom repository
- xxxxx
upload-content Upload content into the repository
Options:
-h, --help print help
Show a custom repository
Usage:
[OPTIONS]
Options:
--id ID repository ID
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
-h, --help print help
List of enabled repositories
Usage:
[OPTIONS]
Options:
--by BY Field to sort the results on
--content-type CONTENT_TYPE limit to only repositories of this time
- xxxxx
--content-view CONTENT_VIEW_NAME Content view name
- xxxxx
--content-view-id CONTENT_VIEW_ID content view numeric identifier
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--library LIBRARY show repositories in Library and the default content view
One of true/false, yes/no, 1/0.
- xxxxx
--lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME Name to search by
- xxxxx
--lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID
--name NAME name of the repository
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--search SEARCH Search string
-h, --help print help
Sync a repository
Usage:
[OPTIONS]
Options:
--async Do not wait for the task
--id ID repository ID
--name NAME Repository name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
-h, --help print help
manipulate repository sets on the server
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
available-repositories Get list or available repositories for the repository set
disable Disable a repository form the set
enable Enable a repository from the set
info Get info about a repository set
list List repository sets for a product.
Options:
-h, --help print help
Get list or available repositories for the repository set
Usage:
[OPTIONS]
Options:
--id ID ID of the repository set
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
-h, --help print help
Disable a repository form the set
Usage:
[OPTIONS]
Options:
--basearch BASEARCH Basearch to disable
--id ID ID of the repository set to enable
--name NAME Repository set name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--releasever RELEASEVER Releasever to disable
-h, --help print help
Enable a repository from the set
Usage:
[OPTIONS]
Options:
--basearch BASEARCH Basearch to enable
--id ID ID of the repository set to enable
--name NAME Repository set name to search by
--new-name NEW_NAME
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
--releasever RELEASEVER Releasever to enable
-h, --help print help
Get info about a repository set
Usage:
[OPTIONS]
Options:
--id ID ID of the repository set
--name NAME Repository set name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
-h, --help print help
List repository sets for a product.
Usage:
[OPTIONS]
Options:
--name NAME Repository set name to search on
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--product PRODUCT_NAME Product name to search by
--product-id PRODUCT_ID product numeric identifier
-h, --help print help
Manage user roles.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
create Create a role
delete Delete a role
filters List all filters
list List all roles
update Update a role
Options:
-h, --help print help
Create a role
Usage:
[OPTIONS]
Options:
--name NAME
-h, --help print help
Delete a role
Usage:
[OPTIONS]
Options:
--id ID
--name NAME User role name
-h, --help print help
List all filters
Usage:
[OPTIONS]
Options:
--id ID User role id
--name NAME User role name
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
-h, --help print help
List all roles
Usage:
[OPTIONS]
Options:
--order ORDER Sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH Filter results
-h, --help print help
Update a role
Usage:
[OPTIONS]
Options:
--id ID
--name NAME User role name
--new-name NEW_NAME
-h, --help print help
Interactive shell
Usage:
[OPTIONS]
Options:
-h, --help print help
Manipulate subscriptions.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
delete-manifest Delete manifest from Red Hat provider
list List organization subscriptions
manifest-history obtain manifest history for subscriptions
refresh-manifest Refresh previously imported manifest for Red Hat provider
upload Upload a subscription manifest
Options:
-h, --help print help
Delete manifest from Red Hat provider
Usage:
[OPTIONS]
Options:
--async Do not wait for the task
--content-host CONTENT_HOST_NAME Name to search by
--content-host-id CONTENT_HOST_ID UUID of the content host
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List organization subscriptions
Usage:
[OPTIONS]
Options:
--activation-key ACTIVATION_KEY_NAME Activation key name to search by
--activation-key-id ACTIVATION_KEY_ID ID of the activation key
--by BY Field to sort the results on
--content-host CONTENT_HOST_NAME Name to search by
--content-host-id CONTENT_HOST_ID UUID of the content host
--full-results FULL_RESULTS Whether or not to show all results
One of true/false, yes/no, 1/0.
--order ORDER Sort field and order, eg. ‘name DESC’
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return
--search SEARCH Search string
-h, --help print help
obtain manifest history for subscriptions
Usage:
[OPTIONS]
Options:
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Refresh previously imported manifest for Red Hat provider
Usage:
[OPTIONS]
Options:
--async Do not wait for the task
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Upload a subscription manifest
Usage:
[OPTIONS]
Options:
--async Do not wait for the task
--file MANIFEST Subscription manifest file
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--repository-url REPOSITORY_URL repository url
-h, --help print help
Manipulate sync plans
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
create Create a sync plan
delete Destroy a sync plan
info Show a sync plan
list List sync plans
update Update a sync plan
Options:
-h, --help print help
Create a sync plan
Usage:
[OPTIONS]
Options:
--description DESCRIPTION sync plan description
--interval INTERVAL how often synchronization should run
One of 'none', 'hourly', 'daily', 'weekly'
Default: "none"
--name NAME sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-date SYNC_DATE start date and time of the synchronization defaults to now
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
Default: "2014-09-16 14:47:03"
-h, --help print help
Destroy a sync plan
Usage:
[OPTIONS]
Options:
--id ID sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
Show a sync plan
Usage:
[OPTIONS]
Options:
--id ID sync plan numeric identifier
--name NAME Sync plan name to search by
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
-h, --help print help
List sync plans
Usage:
[OPTIONS]
Options:
--interval INTERVAL filter by interval
--name NAME filter by name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-date SYNC_DATE filter by sync date
-h, --help print help
Update a sync plan
Usage:
[OPTIONS]
Options:
--description DESCRIPTION sync plan description
--id ID sync plan numeric identifier
--interval INTERVAL how often synchronization should run
One of 'none', 'hourly', 'daily', 'weekly'
--name NAME Sync plan name to search by
--new-name NEW_NAME sync plan name
--organization ORGANIZATION_NAME Organization name to search by
--organization-id ORGANIZATION_ID organization ID
--organization-label ORGANIZATION_LABEL Organization label to search by
--sync-date SYNC_DATE start date and time of the synchronization
Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
-h, --help print help
Tasks related actions.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
progress Show the progress of the task
Options:
-h, --help print help
Show the progress of the task
Usage:
[OPTIONS]
Options:
--id ID UUID of the task
--name NAME Name to search by
-h, --help print help
Manipulate users.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
add-role Assign a user role
create Create a user
delete Delete a user
info Show a user
list List all users
remove-role Remove a user role
update Update a user
Options:
-h, --help print help
Assign a user role
Usage:
[OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help print help
Create a user
Usage:
[OPTIONS]
Options:
--admin ADMIN is an admin account
One of true/false, yes/no, 1/0.
--auth-source-id AUTH_SOURCE_ID
--default-location-id DEFAULT_LOCATION_ID
--default-organization-id DEFAULT_ORGANIZATION_ID
--firstname FIRSTNAME
--lastname LASTNAME
--login LOGIN
--mail MAIL
--password PASSWORD
-h, --help print help
Delete a user
Usage:
[OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
-h, --help print help
Show a user
Usage:
[OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
-h, --help print help
List all users
Usage:
[OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
-h, --help print help
Remove a user role
Usage:
[OPTIONS]
Options:
--id ID
--login LOGIN User's login to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help print help
Update a user
Usage:
[OPTIONS]
Options:
--admin ADMIN is an admin account
One of true/false, yes/no, 1/0.
--auth-source-id AUTH_SOURCE_ID
--default-location-id DEFAULT_LOCATION_ID
--default-organization-id DEFAULT_ORGANIZATION_ID
--firstname FIRSTNAME
--id ID
--lastname LASTNAME
--login LOGIN User's login to search by
--mail MAIL
--new-login NEW_LOGIN
--password PASSWORD
-h, --help print help
Manage user groups.
Usage:
[OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND subcommand
[ARG] ... subcommand arguments
Subcommands:
add-role Assign a user role
add-user Associate an user
add-user-group Associate an user group
create Create a user group
delete Delete a user group
info Show a user group
list List all user groups
remove-role Remove a user role
remove-user Disassociate an user
remove-user-group Disassociate an user group
update Update a user group
Options:
-h, --help print help
Assign a user role
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help print help
Associate an user
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Associate an user group
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help print help
Create a user group
Usage:
[OPTIONS]
Options:
--name NAME
--role-ids ROLE_IDS Comma separated list of values.
--user-group-ids USER_GROUP_IDS Comma separated list of values.
--user-ids USER_IDS Comma separated list of values.
-h, --help print help
Delete a user group
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
-h, --help print help
Show a user group
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
-h, --help print help
List all user groups
Usage:
[OPTIONS]
Options:
--order ORDER sort results
--page PAGE paginate results
--per-page PER_PAGE number of entries per request
--search SEARCH filter results
-h, --help print help
Remove a user role
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--role ROLE_NAME User role name
--role-id ROLE_ID
-h, --help print help
Disassociate an user
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user USER_LOGIN User's login to search by
--user-id USER_ID
-h, --help print help
Disassociate an user group
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--user-group USER_GROUP_NAME Name to search by
--user-group-id USER_GROUP_ID
-h, --help print help
Update a user group
Usage:
[OPTIONS]
Options:
--id ID
--name NAME Name to search by
--new-name NEW_NAME
--role-ids ROLE_IDS Comma separated list of values.
--user-group-ids USER_GROUP_IDS Comma separated list of values.
--user-ids USER_IDS Comma separated list of values.
-h, --help print help