Business Services Commands
The business-services command group manages Business Services — organizational labels that group resources (Users, Accounts, Pipelines, Endpoints, and other entities) within a Domain for access control and reporting purposes.
For command line syntax, see the UDMG Client CLI overview.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
business-services list | Returns all Business Services. | Any |
business-services list-accessible | Returns only the Business Services that the authenticated User is permitted to access. | Any |
business-services get <name> | Retrieves the full definition of a Business Service identified by name. | Any |
business-services create | Creates a Business Service. |
|
business-services update <name> | Updates one or more properties of an existing Business Service. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged. |
|
business-services delete <name> | Permanently deletes a Business Service. |
|
business-services list-users <name> | Returns all Users assigned to the specified Business Service. | Any |
business-services list-entities <name> | Returns all entities (Accounts, Pipelines, Endpoints, and other resources) assigned to the specified Business Service. | Any |
Authentication
Every udmg-client command authenticates to the UDMG Server using a UDMG username and password. Supply them with the --auth-username and --auth-password flags, or set the UDMG_CLI_AUTH_USERNAME and UDMG_CLI_AUTH_PASSWORD environment variables. For details and examples, see Authentication.
Commands Reference
list
Description
Returns all Business Services.
Required role
- Any
Command line syntax
udmg-client [global options] business-services list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services list --page 1 --page-size 10
list-accessible
Description
Returns only the Business Services that the authenticated User is permitted to access.
Required role
- Any
Command line syntax
udmg-client [global options] business-services list-accessible
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services list-accessible
get
Description
Retrieves the full definition of a Business Service identified by name.
Required role
- Any
Command line syntax
udmg-client [global options] business-services get <name>
Arguments
| Argument | Description |
|---|---|
<name> | Business Service name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services get finance
create
Description
Creates a Business Service.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] business-services create [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Business Service name. | Yes | N/A |
--description | The description of the Business Service. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services create --name my-service --description "Core business unit"
update
Description
Updates one or more properties of an existing Business Service. Only the flags explicitly provided are sent; omitted flags leave the corresponding fields unchanged.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] business-services update <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Business Service name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | New name for the Business Service. | No | (none) |
--description | The new description of the Business Service. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services update my-service --name my-service-updated --description "Core business unit"
delete
Description
Permanently deletes a Business Service.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] business-services delete <name>
Arguments
| Argument | Description |
|---|---|
<name> | Business Service name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services delete finance
list-users
Description
Returns all Users assigned to the specified Business Service.
Required role
- Any
Command line syntax
udmg-client [global options] business-services list-users <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Business Service name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services list-users my-service --page 1 --page-size 10
list-entities
Description
Returns all entities (Accounts, Pipelines, Endpoints, and other resources) assigned to the specified Business Service.
Required role
- Any
Command line syntax
udmg-client [global options] business-services list-entities <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Business Service name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client business-services list-entities my-service --page 1 --page-size 10