⚠️ Development Version — You are viewing documentation for a development version (dev_feat.v3.x.aviator.27.1). This version may be unstable or incomplete. — View stable version (v3.x)

Synopsis

fcli aviator admin-config create -p=source -t=<tenant> -u=<aviatorUrl> [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]] [[--admin-config=<configName>]]

Description

Stores the Fortify Aviator URL, tenant and RSA private key that are used by administrator commands like 'fcli aviator app' and 'fcli aviator token'. Required options: --url, --tenant, --private-key.

Examples:

Create the default administrator configuration:
  fcli aviator admin-config create --url https://av.example.com
    --tenant MyTenant --private-key private.pem
Create a named configuration, reading the private key from an env var:
  fcli aviator admin-config create --admin-config prod
    --url https://av.example.com --tenant MyTenant
    --private-key env:AVIATOR_PRIVATE_KEY

Options

-u, --url=<aviatorUrl>

Fortify Aviator URL.

-t, --tenant=<tenant>

Fortify Aviator tenant.

-p, --private-key=source

RSA private key. Can be specified as one of:

file:<local file containing key>
string:<key string value>
env:<env-var name containing key>
If no prefix is given, <local file> is assumed.
Key must be in PEM format.

Fortify Aviator administrator configuration name options

--admin-config=<configName>

Name of the Fortify Aviator administrator configuration to use. Default value: default.

-o, --output=<type+args>

Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.

*--style*=<style>,…​

Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border, wrap, no-wrap, fast-output, no-fast-output, envelope, no-envelope, csv-escape, no-csv-escape.

--store=<var>[:<prop>]

Store JSON results in an fcli variable for later reference.

--to-file=<outputFile>

Write output to the specified file.

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.

--debug

Enable collection of debug logs.