service-instance apply-acl

Apply ACL for a specific service instance.

Syntax

cpd-cli service-instance apply-acl <cpd-service-instance-name> \
[--cpdconfig=<cpd-configuration-location>] \
--from-csv-file=<csv-file-name> \
[--handle-existing-data=skip|replace] \
--profile=<profile-name> \
[--service-type=<cpd-service-type>] \
[--verbose]

Arguments

Table 1: Command arguments
Argument Description
<cpd-service-instance-name> The IBM® Software Hub service instance name to apply ACL for.

Options

Table 1: Command options
Option Description
--cpdconfig The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM Software Hub configuration location.
--from-csv-file A comma-separated (CSV) file that describes the user details.
Status
Required.
Syntax
--from-csv-file=<csv-file-name>
Default value
No default.
Valid values
A valid *.csv file name.
--handle-existing-data Specify an option for handling existing data.
Status
Optional.
Syntax
--handle-existing-data=skip|replace
Default value
skip
Valid values
skip
Skip existing data (the default setting).
replace
Replace existing data.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--profile The name of the profile that you created to store information about an instance of IBM Software Hub and your credentials for the instance.
Status
Required.
Syntax
--profile=<profile-name>
Default value
No default.
Valid values

The name of the profile that you created.

--service-type

-t

 The IBM Software Hub service instance type.
Status
Optional.
Syntax
--service-type=<cpd-service-type>
Default value
No default.
Valid values
Any valid IBM Software Hub service type. For example, 'dv'. Use the 'cpd-cli service-instance list' command to find the service type.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.

Apply ACL for the ps::acltrial service instance by using the aclinfos.csv file and skip existing users or groups.
cpd-cli service-instance apply-acl ps::acltrial \
--from-csv-file=aclinfos.csv \
--handle-existing-data=skip \
--profile=<profile-name>
aclinfos.csv file content:
user_or_group_name,is_group,roles
user1,n,Admin
user2,n,Editor
bvt_group,y,Editor
administrator_group,y,Editor
aclinfos.csv file report:
user_or_group_name,is_group,status,message
user1,n,success,processed
user2,n,success,processed
bvt_group,y,success,processed
administrator_group,y,success,processed
Apply ACL for the ps::acltrial service instance by using the aclinfos.csv file and replace existing users or groups.
cpd-cli service-instance apply-acl ps::acltrial \
--from-csv-file=aclinfos.csv \
--handle-existing-data=replace \
--profile=${CPD_PROFILE_NAME}
aclinfos.csv file content:
user_or_group_name,is_group,roles
user1,n,Admin
user2,n,Editor
bvt_group,y,Editor
administrator_group,y,Editor
aclinfos.csv file report:
user_or_group_name,is_group,status,message
user1,n,success,processed
user2,n,success,processed
bvt_group,y,success,processed
administrator_group,y,success,processed