File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_pam_entitlements_export.1
.TH "GCLOUD_ALPHA_PAM_ENTITLEMENTS_EXPORT" 1
.SH "NAME"
.HP
gcloud alpha pam entitlements export \- export a Privileged Access Manager entitlement into a local YAML file
.SH "SYNOPSIS"
.HP
\f5gcloud alpha pam entitlements export\fR (\fIENTITLEMENT\fR\ :\ \fB\-\-folder\fR=\fIFOLDER\fR\ \fB\-\-location\fR=\fILOCATION\fR\ \fB\-\-organization\fR=\fIORGANIZATION\fR) [\fB\-\-destination\fR=\fIDESTINATION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Export a Privileged Access Manager (PAM) entitlement into a local
YAML file.
.SH "EXAMPLES"
The following command exports an entitlement with a name of
\f5sample\-entitlement\fR, in a project named \f5sample\-project\fR, and in
location \f5global\fR to a local YAML file named \f5sample\-entitlement.yaml\fR:
.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
\-\-project=sample\-project \-\-location=global \e
\-\-destination=sample\-entitlement.yaml
.RE
The following command exports an entitlement with a name of
\f5sample\-entitlement\fR, in a folder with ID \f5\fIFOLDER_ID\fR\fR, and in
location \f5global\fR to a local YAML file named \f5sample\-entitlement.yaml\fR:
.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
\-\-folder=FOLDER_ID \-\-location=global \e
\-\-destination=sample\-entitlement.yaml
.RE
The following command exports an entitlement with a name of
\f5sample\-entitlement\fR, in an organization with ID
\f5\fIORGANIZATION_ID\fR\fR, and in location \f5global\fR to a local YAML file
named \f5sample\-entitlement.yaml\fR:
.RS 2m
$ gcloud alpha pam entitlements export sample\-entitlement \e
\-\-organization=ORGANIZATION_ID \-\-location=global \e
\-\-destination=sample\-entitlement.yaml
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Entitlement resource \- Name of the entitlement to export. The arguments in this
group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.
To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5entitlement\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR. This resource can be one of the following
types: [privilegedaccessmanager.projects.locations.entitlements,
privilegedaccessmanager.folders.locations.entitlements,
privilegedaccessmanager.organizations.locations.entitlements].
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fIENTITLEMENT\fR
ID of the entitlement or fully qualified identifier for the entitlement.
To set the \f5entitlement\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5entitlement\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-folder\fR=\fIFOLDER\fR
The name of the folder
To set the \f5folder\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5entitlement\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-folder\fR on the command line. Must be specified for
resource of type [privilegedaccessmanager.folders.locations.entitlements].
.RE
.sp
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
The resource location
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5entitlement\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp
.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION\fR
The name of the organization
To set the \f5organization\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5entitlement\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-organization\fR on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations.entitlements].
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-destination\fR=\fIDESTINATION\fR
Path to a YAML file where the configuration will be exported. The exported data
will not contain any output\-only fields. Alternatively, you may omit this flag
to write to standard output. For a schema describing the export/import format,
see $CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
.RE
.sp
.SH "GCLOUD WIDE FLAGS"
These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.
Run \fB$ gcloud help\fR for details.
.SH "API REFERENCE"
This command uses the \fBprivilegedaccessmanager/v1alpha\fR API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam\-overview
.SH "NOTES"
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:
.RS 2m
$ gcloud pam entitlements export
.RE
.RS 2m
$ gcloud beta pam entitlements export
.RE