`bm admin cluster iam export`

Description

The bm admin cluster iam export command exports IAM metadata for use with the bm admin cluster iam import command.

The command saves the output as ALIAS-iam-metadata.zip, where ALIAS is the alias of the Buckit deployment.

EXAMPLE

The following command exports all IAM metadata for the mybuckit deployment.

bm admin cluster iam export mybuckit

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] admin cluster iam export ALIAS  \
                 [--output, -o <string>]

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

bm admin cluster iam export adds support for aliases ending with a trailing forward slash ALIAS/. Prior to this release, the command would fail when provided a trailing forward slash.

Parameters

ALIAS: Required
The alias of the Buckit deployment to export IAM metadata for.

--output, --o: Optional
Specify a custom file and path to use when exporting the IAM data.

Global Flags

This command supports any of the global flags.

Examples

Download all IAM metadata for a cluster to a ZIP file

The following command downloads all IAM metadata for the cluster at alias mybuckit, then stores the metadata to a ZIP file.

bm admin cluster iam export mybuckit

The ZIP file is named <alias>-iam-info.zip where <alias> is the alias of the cluster. For the above example, the file is named mybuckit-iam-info.zip.

The file is placed in the current active directory path.

Download all IAM metadata for a cluster and specify the name and path of the ZIP file

The following command downloads all IAM metadata for the cluster at alias mybuckit, then stores the metadata to a ZIP file at /tmp/mybuckit-iam.zip.

bm admin cluster iam export mybuckit --output /tmp/mybuckit-iam.zip