diff --git a/_data/versions/release.yml b/_data/versions/release.yml index a118cac0f..1bae42124 100644 --- a/_data/versions/release.yml +++ b/_data/versions/release.yml @@ -1,3 +1,4 @@ +- 'v2.10.1' - 'v2.10.0' - 'v2.9.1' - 'v2.9.0' diff --git a/dev-info.html b/dev-info.html index 325f90ff8..fdc51fbd0 100644 --- a/dev-info.html +++ b/dev-info.html @@ -863,7 +863,7 @@

Action sche diff --git a/index.html b/index.html index aa65bf869..68ce4cde2 100644 --- a/index.html +++ b/index.html @@ -84,7 +84,7 @@

Version none
-Last updated 2024-12-05 12:52:56 UTC +Last updated 2024-12-05 13:13:46 UTC
diff --git a/v2.10.1/fod-actions.html b/v2.10.1/fod-actions.html new file mode 100644 index 000000000..a75a20435 --- /dev/null +++ b/v2.10.1/fod-actions.html @@ -0,0 +1,712 @@ +--- +title: Fcli FoD Actions +fcli_version: 2.10.1 +--- + + + + + + + +Fcli FoD Actions + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+
+
+

This manual page describes built-in fcli FoD actions that can be run through +the fcli fod action run <action-name> command.

+
+
+
+
+

sample

+
+
+

Sample Action

+
+
+

Synopsis

+
+

fcli fod action run sample [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action documents action syntax to allow users to build their own custom actions. +Note that action syntax is subject to change. Custom action YAML files that work fine +on the current fcli version may not work on either older or newer fcli versions, and +thus may need to be updated when upgrading fcli. Please see this link for details: +https://github.com/fortify/fcli/issues/515

+
+
+
+

Options

+
+
+
--file, -f
+
+

Output file name (or 'stdout' / 'stderr'). Default value: sample.json

+
+
--github-token
+
+

Required GitHub Token. Default value: GITHUB_TOKEN environment variable.

+
+
--github-org, --gho
+
+

GitHub owner/organization for which to list repositories

+
+
+
+
+
+
+
+

aws-sast-report

+
+
+

Generate a AWS Security Hub SAST report listing FoD SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run aws-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generate a ASFF report to integrate AWS Security Hub, generated reports +then parsed by the lambda function, see: https://github.com/fortify/CloudDevSecOpsTemplates/ +For information on how to create or update findings into AWS Security Hub, see +https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-update-types.html

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional report output file name (or 'stdout' / 'stderr'). Default value: aws-fortify-report.json

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
--aws-region
+
+

Required AWS region. Default value: AWS_REGION environment variable.

+
+
--aws-account
+
+

Required AWS account id. Default value: AWS_ACCOUNT_ID environment variable.

+
+
+
+
+
+
+
+

bitbucket-sast-report

+
+
+

Generate a BitBucket Code Insights report listing FoD SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run bitbucket-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into BitBucket, see +https://support.atlassian.com/bitbucket-cloud/docs/code-insights/

+
+
+
+

Options

+
+
+
--report-file, -r
+
+

Optional report output file name (or 'stdout' / 'stderr'). Default value: bb-fortify-report.json

+
+
--annotations-file, -a
+
+

Optional annotations output file name (or 'stdout' / 'stderr'). Default value: bb-fortify-annotations.json

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

check-policy

+
+
+

Check security policy.

+
+
+

Synopsis

+
+

fcli fod action run check-policy [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action checks the outcome of the FoD Security Policy, returning a non-zero +exit code if FoD Security Policy status is Fail. Having this defined in an fcli +action allows for users to implement custom security policy checks through a +custom action, for example if they need more granuality than what’s provided +by the standard FoD Security Policy.

+
+
+
+

Options

+
+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

github-pr-comment

+
+
+

(PREVIEW) Add GitHub Pull Request review comments.

+
+
+

Synopsis

+
+

fcli fod action run github-pr-comment [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action adds review comments to a GitHub Pull Request. Currently +this is marked as PREVIEW as we build out this functionality; later +versions may have different behavior and/or require different action +parameters.

+
+
+

The current implementation simply compares current scan results +against previous scan results in the given FoD release, listing +all new, re-introduced and removed issues in a new PR comment.

+
+
+

For best results, this fcli action should only be run on GitHub +pull_request triggers. Upon PR creation, a new FoD release should +be created, copying state from the FoD release that represents the +branch into which the PR will be merged, and a new scan should be +run on the current PR branch before invoking this fcli action.

+
+
+

This will ensure that scan results for the current PR will be +compared against the latest scan results for the target branch +upon PR creation. Optionally, new scans can be run upon PR changes, +creating new PR comments that show the issue delta compared to the +previous scan for this PR.

+
+
+
+

Options

+
+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
--scan-type, -t
+
+

Scan type for which to list vulnerabilities. Default value: Static

+
+
--github-token
+
+

Required GitHub Token. Default value: GITHUB_TOKEN environment variable.

+
+
--github-owner
+
+

Required GitHub repository owner. Default value: GITHUB_REPOSITORY_OWNER environment variable.

+
+
--github-repo
+
+

Required GitHub repository. Default value: Taken from GITHUB_REPOSITORY environment variable.

+
+
--pr
+
+

Required PR number. Default value: Taken from GITHUB_REF_NAME environment variable. Note that default value will only work on GitHub pull_request triggers; if this fcli action is invoked through any other GitHub trigger, it will fail unless an explicit PR number is passed through this option.

+
+
--commit
+
+

Required commit hash. Default value: GITHUB_SHA environment variable.

+
+
--dryrun
+
+

Set to true to just output PR decoration JSON; don’t actually update any PR

+
+
+
+
+
+
+
+

github-sast-report

+
+
+

Generate a GitHub Code Scanning report listing FoD SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run github-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitHub, see +https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gh-fortify-sast.sarif

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

gitlab-dast-report

+
+
+

Generate a GitLab DAST report listing FoD DAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run gitlab-dast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdast

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-dast.json

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

gitlab-sast-report

+
+
+

Generate a GitLab SAST report listing FoD SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run gitlab-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportssast

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-sast.json

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

release-summary

+
+
+

(PREVIEW) Generate release summary.

+
+
+

Synopsis

+
+

fcli fod action run release-summary [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generates a short summary listing issue counts and other statistics +for a given release. Based on user feedback on this initial version of this action, +parameters and output of this action may change in the next couple of fcli releases.

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: stdout

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

sarif-sast-report

+
+
+

Generate SARIF report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run sarif-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generates a SARIF report listing Fortify SAST vulnerabilities, which +may be useful for integration with various 3rd-party tools that can ingest SARIF +reports. For more information about SARIF, please see +https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: fortify-sast.sarif

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+

setup-release

+
+
+

Set up application release.

+
+
+

Synopsis

+
+

fcli fod action run setup-release [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

This action allows for preparing an application release for running an application +security scan. It will create the application and/or release if they do not exist +yet, and optionally configure scan settings. For now, only static scan setup is +supported, including optional software composition analysis. Support for other +scan types like Dynamic or Mobile may be added in the future, or you may consider +implementing a custom setup action to set up other scan types.

+
+
+

Although the same functionality can be achieved by manually running the various +fcli commands used by this action, like fcli fod release create and +fcli fod sast-scan setup, this action provides a convenient and standardized +approach for running those commands, providing default values for many of the +required options.

+
+
+

To provide even more consistency across CI/CD pipelines in your organization, it +is recommended to implement one or more custom setup actions that provide suitable +default values or even hard-coded, non-overridable values for the various options, +for example based on business unit, team, and/or application type. Such custom +actions could for example set standard application or release attributes for a +particular type of application to be scanned. Alternative to implementing multiple +custom actions, you may also consider implementing a single custom action that takes +for example a --profile option to select between different profiles that each define +appropriate option values and setup commands to run.

+
+
+
+

Options

+
+
+
--release, --rel
+
+

Required release name as <application>[:<microservice>]:<release>

+
+
--scan-types, -t
+
+

Optional comma-separated list of scan type(s) to set up; for now, only 'sast' is supported

+
+
--attributes, --attrs
+
+

Optional comma-separated list of attributes to set on the application and/or release

+
+
--copy-from
+
+

See fcli fod release create

+
+
--description, -d
+
+

See fcli fod release create

+
+
--sdlc-status, --status
+
+

See fcli fod release create. Default value: Development

+
+
--app-description
+
+

See fcli fod release create

+
+
--app-notify
+
+

See fcli fod release create

+
+
--app-owner
+
+

See fcli fod release create

+
+
--app-groups
+
+

See fcli fod release create

+
+
--app-type
+
+

See fcli fod release create. Default value: Web

+
+
--app-criticality
+
+

See fcli fod release create. Default value: Medium

+
+
--assessment-type
+
+

See fcli fod sast-scan setup

+
+
--use-aviator
+
+

See fcli fod sast-scan setup

+
+
--oss
+
+

See fcli fod sast-scan setup

+
+
+
+
+
+
+
+

sonarqube-sast-report

+
+
+

Generate a SonarQube External Issues report listing FoD SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli fod action run sonarqube-sast-report [fcli fod action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into SonarQube, see +https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/importing-external-issues/external-analyzer-reports/

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: sq-fortify-sast.json

+
+
--file-path-prefix, --pfx
+
+

Optional prefix for issue file paths

+
+
--release, --rel
+
+

Required release id or <appName>:[<microserviceName>:]<releaseName>

+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/index.html b/v2.10.1/index.html new file mode 100644 index 000000000..0c4ce2054 --- /dev/null +++ b/v2.10.1/index.html @@ -0,0 +1,1467 @@ +--- +title: Fortify CLI (fcli) Installation & Usage +fcli_version: 2.10.1 +--- + + + + + + + +Fortify CLI (fcli) Installation & Usage + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Introduction

+
+
+

The fcli utility can be used to interact with various Fortify products, like Fortify on Demand (FoD), Software Security Center (SSC), ScanCentral SAST and ScanCentral DAST. This document describes installation and general usage of fcli. For a full listing of fcli commands and corresponding command line options, please see the +man-pages as listed in the Manual Pages section.

+
+
+

Some of the fcli highlights:

+
+
+ +
+
+

The following Fortify products are currently supported by fcli:

+
+
+
    +
  • +

    Software Security Center (SSC)

    +
    +
      +
    • +

      Includes virtually all functionality provided by the legacy FortifyClient utility

      +
      • +
    • +

      Includes virtually all functionality provided by the ssc-client sample shipped with SSC

      +
      • +
    • +

      Adds a wide range of other functionalities not previously included in any Fortify client-side utilities

      +
      • +
    +
    +
    • +
  • +

    ScanCentral SAST

    +
    +
      +
    • +

      Support for starting and managing ScanCentral SAST scans

      +
      • +
    +
    +
    • +
  • +

    ScanCentral DAST

    +
    +
      +
    • +

      Support for starting and managing ScanCentral DAST scans

      +
      • +
    • +

      Support for listing scan policies and settings

      +
      • +
    • +

      Support for listing and managing sensors

      +
      • +
    +
    +
    • +
  • +

    Fortify on Demand (FoD)

    +
    +
      +
    • +

      Support for creating and managing applications, microservices and releases

      +
      • +
    • +

      Support for starting and managing SAST & OSS scans

      +
      • +
    • +

      Support for importing/downloading SAST/DAST/MAST & OSS results

      +
      • +
    • +

      Partial/preview support for starting and managing DAST & MAST scans

      +
      • +
    • +

      Partial/preview support for managing users, groups and their assignments

      +
      • +
    +
    +
    • +
+
+
+

Some commands and options are either hidden or marked as PREVIEW or LEGACY; these may change at any time, even between minor fcli versions. Any fcli invocations using these commands or options may break when upgrading to a future fcli 2.x version, so if possible you should refrain from using these in pipelines for example. Most notably, this includes the following functionalities:

+
+
+
    +
  • +

    Commands for configuring and running FoD DAST & MAST scans will change significantly, based on upcoming FoD API changes & improvements

    +
    • +
+
+
+

Hidden commands are not listed in fcli help output and not included in the Manual Pages. If needed, you can view the list of hidden commands using the fcli util all-commands list -q hidden command.

+
+
+
+
+

Release Assets

+
+
+

Release assets for fcli are available on the Releases page. This page lists both development releases (named Development Release - <branch> branch) and final releases. In general, the use of a final release is recommended, unless you want to use any functionality that hasn’t made it into a final release yet.

+
+
+

Each release comes with a list of assets:

+
+
+
    +
  • +

    docs-html.zip & docs-manpage.zip: Manual pages in either HTML or manpage format

    +
    • +
  • +

    fcli-linux.tgz, fcli-mac.tgz & fcli-windows.zip: Native binaries for each of the mentioned platforms

    +
    +
      +
    • +

      Note that some browsers by default will disallow downloading of fcli-windows.zip; please bypass the warning

      +
      • +
    • +

      Linux and Mac downloads include an auto-completion script that makes interactive fcli usage easier

      +
      • +
    +
    +
    • +
  • +

    fcli.jar: Java version of fcli, which should be runnable on any platform that has Java 17+ installed

    +
    +
      +
    • +

      Note that in general, the native binaries are easier to invoke, offer better performance, and have the benefit of auto-completion capabilities on Linux & Mac

      +
      • +
    • +

      If you experience any unexpected behavior with native binaries, like commands or command line options not being listed or recognized, or technical error messages about methods, constructors or serializers not being +found, please try with the Java version as it may be an issue specific to the native binaries. See the Troubleshooting section for details.

      +
      • +
    +
    +
    • +
  • +

    fcli-thirdparty.zip: Third-party licenses and sources for license purposes; usually no need to download

    +
    • +
  • +

    LICENSE.TXT & README.md: Some generic information and license for fcli

    +
    • +
  • +

    *.sha256: SHA256 checksum for each asset

    +
    • +
  • +

    *.rsa_sha256: RSA SHA256 signature for each asset, to be verified using this public key

    +
    • +
+
+
+

Please note that when publishing a new release, it may take up to 30-60 minutes before release assets are posted. If the latest release doesn’t show any of the assets listed above, please check again in 30-60 minutes. If you encounter a release without these assets after waiting for 60 minutes, please consider submitting an issue on the fcli issue tracker.

+
+
+
+
+

Installation

+
+
+

The instructions in this section are only applicable if you wish to install the native or Java binaries onto your local system. We also provide Docker images for fcli; see fortifydocker/fcli for information on how to run fcli using these Docker images.

+
+
+

To install the fcli executables on your local system, start by visiting the fcli Releases page as described in the previous section, and downloading the fcli.jar file or appropriate native binary archive for your platform. Native binary archives will need to be extracted to a temporary directory, the fcli.jar file can be used as-is.

+
+
+

As a best practice, you should verify the integrity of the downloaded file. Release assets include *.sha256 and *.rsa_sha256 for this purpose, with the latter being preferred for better security. For example, after downloading both fcli-linux.tgz and fcli-linux.tgz.rsa_sha256, you can verify integrity by running the following OpenSSL command:

+
+
+
+
  openssl dgst -sha256 -verify <(echo "-----BEGIN PUBLIC KEY-----
+  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArij9U9yJVNc53oEMFWYp
+  NrXUG1UoRZseDh/p34q1uywD70RGKKWZvXIcUAZZwbZtCu4i0UzsrKRJeUwqanbc
+  woJvYanp6lc3DccXUN1w1Y0WOHOaBxiiK3B1TtEIH1cK/X+ZzazPG5nX7TSGh8Tp
+  /uxQzUFli2mDVLqaP62/fB9uJ2joX9Gtw8sZfuPGNMRoc8IdhjagbFkhFT7WCZnk
+  FH/4Co007lmXLAe12lQQqR/pOTeHJv1sfda1xaHtj4/Tcrq04Kx0ZmGAd5D9lA92
+  8pdBbzoe/mI5/Sk+nIY3AHkLXB9YAaKJf//Wb1yiP1/hchtVkfXyIaGM+cVyn7AN
+  VQIDAQAB
+  -----END PUBLIC KEY-----") -signature "fcli-linux.tgz.rsa_sha256" "fcli-linux.tgz"
+
+
+
+

If your shell doesn’t support <(...) syntax, you’ll need to save the public key to a file and pass the file name to the -verify command line option, for example:

+
+
+
+
  openssl dgst -sha256 -verify pubkey.pem -signature "fcli-linux.tgz.rsa_sha256" "fcli-linux.tgz"
+
+
+
+

Once downloaded, verified and extracted (if applicable), you can either perform a manual or managed installation. Managed installation is recommended, but only available on internet-connected systems. Please see the sections below for more information.

+
+
+

Managed Installation

+
+

Managed installation is only available on internet-connected systems, or if your company hosts the various Fortify tools (including fcli) internally and provides a corresponding custom tool definitions bundle. Advantages of a managed installation:

+
+
+
    +
  • +

    Both fcli and other tools installed using fcli tool commands will be hosted under a single base directory

    +
    • +
  • +

    This base directory will contain a single bin directory that can be added to your PATH for easy invocation of all tools installed through fcli

    +
    • +
  • +

    The fcli tool fcli list command can be used to list both installed and available fcli versions

    +
    • +
  • +

    The fcli tool fcli install command can be used to easily upgrade the current fcli version

    +
    • +
+
+
+

The steps below describe how to perform a managed fcli installation. The syntax for invoking the various commands depends on the fcli variant that you downloaded. If you downloaded fcli.jar, fcli can be invoked using java -jar /path/to/fcli.jar. If you downloaded a native binary, fcli can be invoked using /path/to/fcli (Linux/Mac) or C:\path\to\fcli.exe (Windows). Any use of fcli in the commands below should be replaced by the appropriate command for invoking fcli on your system.

+
+
+
    +
  • +

    If necessary, configure fcli proxy settings:

    +
    +
      +
    • +

      View usage information:
      +fcli config proxy add -h

      +
      • +
    • +

      Configure proxy settings:
      +fcli config proxy add [options]

      +
      • +
    • +

      For example:
      +fcli config proxy add myproxy:8080 -u<proxy user> -p<proxy password>

      +
      • +
    +
    +
    • +
  • +

    Update tool definitions to make fcli aware of latest tool releases:

    +
    +
      +
    • +

      View usage information:
      +fcli tool definitions update -h

      +
      • +
    • +

      Update with default Fortify tool definitions:
      +fcli tool definitions update

      +
      • +
    • +

      Update with company-provided tool definitions:
      +fcli tool definitions update --source <tool-definitions-source>

      +
      • +
    +
    +
    • +
  • +

    Install the latest available fcli version:

    +
    +
      +
    • +

      View usage information:
      +fcli tool fcli install -h

      +
      • +
    • +

      View available fcli versions:
      +fcli tool fcli list

      +
      • +
    • +

      Install the latest available fcli version to the default base directory:
      +fcli tool fcli install -v latest

      +
      • +
    +
    +
    • +
  • +

    Add the global Fortify tools bin directory to your PATH environment variable, for example in the Windows User or System Environment variables, or in your .bashrc or .profile file.

    +
    +
      +
    • +

      Unless --base-dir is specified on the fcli tool fcli install command, the Fortify tools global bin directory defaults to <user.home>/fortify/tools/bin.

      +
      • +
    +
    +
    • +
  • +

    Linux/Mac only: Run the following command to install fcli auto command completion, allowing for use of the <tab> key to get suggestions for fcli command and option names. You may want to add this to your shell startup script like .bashrc, such that fcli auto-completion is readily available in every shell.
    +source <user.home>/fortify/tools/bin/fcli_completion

    +
    • +
+
+
+
+

Manual Installation

+
+
    +
  • +

    Copy the fcli.jar file or the extracted native binaries to a directory of your choosing.

    +
    • +
  • +

    If using fcli.jar, create a simple wrapper script/batch file that invokes java -jar /path/to/fcli.jar, passing all the script arguments to this Java command.

    +
    • +
  • +

    For ease of use, add the directory to your operating system or shell PATH environment variable, or move fcli/fcli.exe/wrapper script to a directory that is already on the PATH

    +
    • +
  • +

    Linux/Mac only: Run the following command to install fcli auto command completion, allowing for use of the <tab> to get suggestions for fcli command and option names. You may want to add this to your shell startup script, such that fcli auto-completion is readily available in every shell.
    +source <extraction-dir>/fcli_completion

    +
    • +
+
+
+
+
+
+

Upgrade

+
+
+

If you prefer a manual installation/upgrade, you can download the latest fcli version for your platform from the fcli Releases page and follow the Manual Installation instructions above, adjusting any manually created wrapper scripts to point to the new installation.

+
+
+

However, on internet-connected systems, or if your company hosts the various Fortify tools (including fcli) internally and provides a corresponding custom tool definitions bundle, the preferred upgrade approach is through the use of fcli commands as described below.

+
+
+

Notes:

+
+
+
    +
  • +

    These steps assume that all other steps from the Managed Installation instructions have already been performed during initial installation, like configuring a proxy server if applicable, and adding the global bin directory to your PATH.

    +
    • +
  • +

    If the requested version has already been installed, it will be used as-is; only post-installation tasks like replacing the global bin-script(s) will be performed.

    +
    • +
  • +

    Similar steps apply for upgrading any of the Fortify-related tools installed through the various fcli tool * install commands.

    +
    • +
+
+
+

Upgrade steps:

+
+
+
    +
  • +

    Update tool definitions to make fcli aware of latest tool releases:

    +
    +
      +
    • +

      Update with default Fortify tool definitions:
      +fcli tool definitions update

      +
      • +
    • +

      Update with company-provided tool definitions:
      +fcli tool definitions update --source <tool-definitions-source>

      +
      • +
    +
    +
    • +
  • +

    Upgrade fcli

    +
    +
      +
    • +

      Install latest version, removing all previous (managed) fcli installations:
      +fcli tool fcli install -v latest --uninstall all

      +
      • +
    • +

      Install latest 2.x.y version, removing all previous 2.x.y installations but keeping any 1.x.y installations:
      +fcli tool fcli install -v 2 --uninstall 2

      +
      • +
    +
    +
    • +
  • +

    Re-source the fcli_completion script if applicable on your platform

    +
    • +
+
+
+
+
+

Command Structure

+
+
+

Fcli provides a product-oriented command structure, with each product represented by a separate tree of subcommands. For example, the fcli fod command tree can be used to interact with Fortify on Demand +(FoD), and the fcli ssc command tree can be used to interact with Fortify Software Security Center (SSC). There are also some non product-related command trees, like the fcli config command tree to manage fcli configuration.

+
+
+

To see what top-level fcli commands are available, you can use the fcli --help command. You can drill down into the command tree to see what sub-commands are available within a particular parent command, for example by running fcli ssc --help to see all fcli ssc sub-commands, or fcli ssc session --help to see all SSC session management commands.

+
+
+

Note that the --help option must be specified after the sub-command for which you want view usage instructions, i.e. fcli ssc --help and not fcli --help ssc. A listing of all available fcli commands can be viewed using the fcli util all-commands list command.

+
+
+

If you don’t have fcli up and running yet, you can also refer to the downloadable or online manual pages; refer to the Manual Pages section for more information.

+
+
+
+
+

Common Options

+
+
+

The following sections describe common options that are available on (most) fcli commands.

+
+
+

-h | --help

+
+

This option can be used on every fcli (sub-)command to view usage information for that command. Usage information usually shows the command synopsis, a description of the functionality provided by the command, and a description of each command line option or parameter accepted by the command.

+
+
+
+

--env-prefix

+
+

As described in the Environment Variables section, default option and parameter values can be retrieved from environment variables starting with FCLI_DEFAULT. This option allows for configuring a different environment variable prefix. This may be useful if, for example, you want to login to multiple instances of the same system using environment variables. For example, when running fcli ssc session login --env-prefix PROD, fcli will look for environment variables like PROD_SSC_URL instead of FCLI_DEFAULT_SSC_URL.

+
+
+

Note that a default value for the --env-prefix option itself can be specified through an FCLI_DEFAULT_ENV_PREFIX environment variable, for example if you want to globally override the FCLI_DEFAULT prefix.

+
+
+
+

--log-level

+
+

This option can be used on every fcli (sub-)command to specify the fcli log level; see the help output for a list of allowed levels. Note that this option also requires the --log-file option to be specified, +otherwise no log will be written.

+
+
+
+

--log-file

+
+

This option can be used on every fcli (sub-)command to specify the file to which to output log data. If not specified, currently no log data will be written, although future versions may specify a default log file +location in the fcli data folder.

+
+
+
+

-o | --output

+
+

Available on virtually all (leaf) commands that output data, this option can be used to specify the output format. Fcli supports a wide variety of output formats, like table, csv, json, xml, and tree formats, allowing for both human-readable output or output suitable for automations. The csv-plain and table-plain output formats produce CSV or table output without headers. The *-flat +output formats produce a flattened view of the output data, potentially making it easier to process that data without having to navigate through an object tree. For a full list of output formats supported by your fcli +version, please refer to the help output or Manual Pages.

+
+
+

Most output formats allow for specifying the JSON properties to be included in the output, for example -o csv=id,name. If no JSON properties are specified, most output formats will output all available +JSON properties, except for table output, which usually outputs a predefined set of JSON properties.

+
+
+

There are two output formats that are somewhat special:

+
+
+
    +
  • +

    -o 'expr=Text with {expression1} or {expression2}\n'
    +Formats the output data based on the given template expression, which is a combination of (optional) plain text and SpEL expressions; see Option Expressions for details. In most cases, expressions will be simple property references, i.e., {property.subProperty}. This can be used for a variety of purposes, for example generating output in a human-readable format, or for generating a list of commands to be run at a later stage. Note that by default, no newline character will be inserted after evaluating the given expression. If necessary, the expression should explicitly include \n to output a newline character. Also note that depending on your shell, the expr option must be properly quoted. For most shells, the expr=... value should be enclosed in single or double quotes. To demonstrate the power of this output format, following are two examples of how -o expr can be used to generate a script that purges all application versions matching certain criteria:

    +
    +
      +
    • +

      fcli ssc appversion list -q 'createdBy=="admin"' -o 'expr=fcli ssc appversion purge-artifacts --older-than 30d {id}\n'

      +
      • +
    • +

      for id in $(fcli ssc appversion list -q 'createdBy=="admin"' -o 'expr={id} '); do echo "fcli ssc appversion purge-artifacts –older-than 30d ${id}'"; done

      +
      • +
    +
    +
    • +
  • +

    -o json-properties
    +List all JSON properties returned by the current command, which can be used on options that take JSON properties as input, like output expressions (-o expr={prop}), properties to include in the output (-o table=prop1,prop2), queries (-q 'prop1=="value1"'), and fcli variables (--store var:prop1,prop2 & ::var::prop1}). Two important notes about this output format:

    +
    +
      +
    • +

      The command will be executed as specified, so be careful when using this output option on any command +that changes state (delete/update/create/…). In most cases, the get or list operations will return a similar set of properties, so you can use those commands to view available properties.

      +
      • +
    • +

      On some commands, the list of available JSON properties may vary depending on command line options. For example, when a query returns no records, then -o json-properties will not output any properties. Likewise, a command may provide options for including additional data for each record; the corresponding JSON properties will only be shown if -o json-properties is used in combination with these options that load additional data.

      +
      • +
    +
    +
    • +
+
+
+
+

--output-to-file

+
+

Available on virtually all (leaf) commands that output data, this option can be used to write the command output data to a file, in the format specified by the --output option listed above. In some cases, this may be more convenient than redirecting the output to a file. For example, although currently not implemented, fcli could potentially skip creating the output file if there is no output data or if an error occurs. Also, for commands that output status updates, like wait-for commands, the --output-to-file option allows for status updates to be written to standard output while the final output of the command will be written to the file specified.

+
+
+
+

--progress

+
+

Various commands offer a --progress option to specify how to output progress messages. This option supports the following values:

+
+
+
    +
  • +

    auto: Automatically select between ansi, single-line and simple depending on console capabilities.

    +
    • +
  • +

    none: Don’t output any progress messages.

    +
    • +
  • +

    simple: Output every progress message on a separate line, effectively leaving older progress messages visible. This will be used by default if no console is available, for example during pipeline runs. Supports multi-line progress messages.

    +
    • +
  • +

    single-line: Uses the \r (carriage return) character to overwrite previous progress message. This will be used by default if a non-ANSI console is detected. Supports single-line progress messages only.

    +
    • +
  • +

    ansi: Uses ANSI escape sequences to overwrite previous progress messages. This will be used by default if ANSI capabilities are detected. Supports multi-line progress messages.

    +
    • +
+
+
+
+

--store

+
+

Available on virtually all (leaf) commands that output data, this option can be used to store command output data in an fcli variable. For more details, see the Fcli Variables section.

+
+
+
+

-q | --query

+
+

Available on most list commands and some other commands, this option allows for querying the output data, outputting only records that match the given Spring Expression Language (SpEL) expression. See the Option Expressions section for details.

+
+
+

Expressions are evaluated on individual records; record properties can be accessed as shown in the SpEL documentation. The list of properties that can be queried can be obtained by executing the current command with the -o json-properties option; see -o | –output for details.

+
+
+

Following are some examples using bash syntax, assuming the record contains p1, p2, …​ properties:

+
+
+
    +
  • +

    -q 'p1=="v1"'
    +Only output records if the value of property p1 equals v1

    +
    • +
  • +

    -q 'p1=="v1" || p1=="v2"'
    +Only output records if the value of property p1 equals either v1 or v2

    +
    • +
  • +

    -q '{"v1","v2"}.contains(p1)'
    +Same as previous, but more concise if matching against many different values

    +
    • +
  • +

    -q 'name matches "val1|val2"'
    +Similar as above, but using regex-based OR matching

    +
    • +
  • +

    -q 'p2==25 || p2<5'
    +Only output records if the value of property p2 either equals 25 or is less than 5

    +
    • +
  • +

    -q 'p1=="v1" && (p2=="v2" || p3=="v2")'
    +Only output records if the value of property p1 equals v1 and the value of either property p2 or p3 is v2

    +
    • +
  • +

    fcli ssc artifact list --appversion MyApp:main -q 'scanTypes matches "\bSCA\b"'
    +Only output artifacts containing a Fortify SCA scan (matching the whole word SCA against scanTypes property)

    +
    • +
  • +

    fcli ssc artifact list --appversion MyApp:main -q '_embed.scans.![buildLabel].contains("myLabel")'
    +Only output artifacts for which any of the scans included in the artifact has a buildLabel that equals myLabel

    +
    • +
  • +

    fcli ssc artifact list --appversion MyApp:main -q '#now("-90d") < #date(uploadDate)'
    +Only output artifacts that were uploaded less than 90 days ago.

    +
    • +
+
+
+

Server-side queries

+
+

In general, queries specified using the -q / --query option are evaluated on the client. Some commands will analyze the given query and generate corresponding server-side query parameters to minimize the amount of data that needs to be transferred from server to client. Generated queries can be viewed in the log file if --log-level is set to DEBUG level.

+
+
+

All commands that automatically generate server-side queries also provide a dedicated option for overriding the automatically generated server-side query, for example to further optimize the query or in case the automatically generated query is causing any issues. Following bullet points provide details on server-side queries for the various product modules:

+
+
+
    +
  • +

    FoD:
    +All commands that automatically generate server-side queries provide the --filters-param option to override the automatically generated query. Server-side queries are automatically generated for the following SpEL expressions:

    +
    +
      +
    • +

      prop1=='value' (simple equals expressions)

      +
      • +
    • +

      prop1=='val1' || prop1=='val2' (or-expressions on a single property)

      +
      • +
    • +

      {'value1','value2'}.contains(prop1) (or-expression on a single property)

      +
      • +
    • +

      prop1 matches 'literalValue1|literalValue2' (or-expression on a single property)

      +
      • +
    • +

      prop1=='value' && prop2 matches 'val1|val2' (and-expression containing any of the above)

      +
      • +
    +
    +
    • +
  • +

    ScanCentral SAST:
    +No server-side queries are automatically being generated.

    +
    • +
  • +

    ScanCentral DAST:
    +No server-side queries are automatically being generated. Some commands provide the --server-query option to explicitly pass query parameters to the server.

    +
    • +
  • +

    SSC:
    +All commands that automatically generate server-side queries provide the --q-param option to override the automatically generated query. Server-side queries are automatically generated for the following SpEL expressions:

    +
    +
      +
    • +

      prop1=='value' (simple equals expressions)

      +
      • +
    • +

      prop1=='value' && prop2=='val2' (and-expression containing simple equals expressions)

      +
      • +
    +
    +
    • +
+
+
+
+
+

--session

+
+

Available on virtually all commands that interact with a target system, this option allows for specifying a session name. For more details, see the Session Management section.

+
+
+
+

Option Expressions

+
+

Various fcli options take either plain expressions, like -q | --query, or template expressions (plain text combined with expressions embedded between curly braces), like -o | –output expr=…​. These expressions use Spring Expression Language (SpEL); general information on syntax, supported operators and more can be found in the SpEL Documentation.

+
+
+

When evaluating expressions, fcli configures SpEL for 'data binding and condition evaluation', meaning that not all SpEL features are available. In particular, query expressions cannot invoke constructors nor static methods, and write access is mostly disabled. Attempts to access non-existing JSON properties will result in an error, which, although uncommon, may be an issue if the server doesn’t consistently return all expected properties. You’ll need to explicitly check for property existence in such cases, for example:

+
+
+
    +
  • +

    Top-level properties:
    +fcli ... list -q '(has("property2") && property2=="value2")'

    +
    • +
  • +

    Nested properties:
    +fcli ... list -q 'nestedObject!=null && get("nestedObject").has("stringValue") && nestedObject.stringValue=="nestedObjectValue1"'

    +
    • +
  • +

    Nested array properties:
    +fcli ... list -q 'nestedObjectArray !=null && !(nestedObjectArray.isEmpty()) && get("nestedObjectArray").get(0).has("stringValue") && nestedObjectArray.get(0).stringValue=="nestedArrayValue1"'

    +
    • +
+
+
+

Some SpEL operators like matches may throw an exception if any of the operands is null. For example, the following will result in an error if the prop1 propery is null for any of the records returned by the list command:

+
+
+
    +
  • +

    fcli ... list -q 'prop1 matches "value1|value2"'

    +
    • +
+
+
+

Such errors can be avoided using one of the following approaches:

+
+
+
    +
  • +

    Rewrite the expression to not use the matches operator, for example:
    +fcli ... list -q '{"value1","value2"}.contains(prop1)'

    +
    • +
  • +

    Add null-check (include all records for which prop is null):
    +fcli ... list -q 'prop1==null || prop1 matches "value1|value2"'

    +
    • +
  • +

    Add null-check (exclude all records for which prop is null):
    +fcli ... list -q 'prop1!=null && prop1 matches "value1|value2"'

    +
    • +
+
+
+

Fcli provides some utility functions that may be used in expressions. Note that these functions calls are preceded by a # character.

+
+
+
    +
  • +

    #date(string): Convert the given date/time in string format to a proper date/time representation, allowing for date/time-based comparison operations. This can be used on property references or literal strings.

    +
    • +
  • +

    #now(): Get the current date/time, allowing for date/time-based comparison operations.

    +
    • +
  • +

    #now(period): Get the current date/time plus or minus the given period. The given period must start with either a + or -, followed by a number and the time unit. Some examples: -90d (now minus 90 days), +15m (now plus 15 minutes) and -90s (now minus 90 seconds).

    +
    • +
  • +

    #var(name): Get fcli variable contents; variable properties can be accessed as usual, i.e. #var("myVar")?.rootProp?.subProp.

    +
    • +
  • +

    #env(name): Get the value of an environment variable.

    +
    • +
+
+
+

Note that for date comparisons, both sides of the comparison operator need to be explicitly defined as date/time objects. For example:

+
+
+
    +
  • +

    Invalid comparison: #date(myprop) < '2023-01-01'

    +
    • +
  • +

    Valid comparison: #date(myprop) < #date('2023-01-01')

    +
    • +
  • +

    Valid comparison: #date(myprop) < #now('-90d')

    +
    • +
+
+
+

SpEL expressions may contain various characters that will be interpreted by some shells, like the # character for calling functions, and either single or double quotes around literal string values. As such, with most shells you should enclose the full expression in single or double quotes, and use the other quotes in the expression, for example:

+
+
+
    +
  • +

    -q '... "literal SpEL string" ...' (single quotes for shell, double quotes for SpEL literals)

    +
    • +
  • +

    -q "... 'literal SpEL string' ..." (double quotes for shell, single quotes for SpEL literals)

    +
    • +
+
+
+

Which one to choose depends on any other characters appearing in the expression. For example, in bash you’d usually use single quotes to have everything in-between passed to fcli as-is, unless you want to use specific shell features inside the expression. Note that you can use the #env function to retrieve environment variable contents, so you don’t need to use shell syntax to insert environment variable contents into expressions.

+
+
+
+
+
+

Session Management

+
+
+

Most fcli product modules are session-based, meaning that you need to run a session login command before you can use most of the other commands provided by a product module, and run a session logout command when finished, for example:

+
+
+
+
fcli ssc session login --url https://my.ssc.org/ssc --user <user> --password <password>
+fcli ssc appversion list
+fcli ssc session logout --user <user> --password <password>
+
+
+
+

For interactive use, you can choose to keep the session open until it expires (expiration period depends on target system and login method). For pipeline use or other automation scenarios, it is highly recommended to issue a session logout command when no further interaction with the target system is required, to allow for any client-side and server-side cleanup to be performed.

+
+
+

For example, upon logging in to SSC with user credentials, fcli will generate a UnifiedLoginToken, which will be invalidated when the ssc session logout is being run. If you have many (frequently executed) pipelines that interact with SSC, and you don’t run the ssc session logout command when the pipeline finishes, you risk exhausting SSC’s limit on active tokens. In addition, the logout commands will perform client-side cleanup, like removing session details like URL and authentication tokens from the client system.

+
+
+

For product modules that support it, like SSC or ScanCentral DAST, it is also highly recommended to use token-based authentication rather than username/password-based authentication when incorporating fcli into pipelines or other automation tasks. This will avoid creation of a temporary token as described above, but also allows for better access control based on token permissions. Similarly, for systems that support Personal Access tokens, like FoD, it is highly recommended to utilize a Personal Access Token rather than user password.

+
+
+

Note however that depending on (personal access) token permissions, not all fcli functionality may be available. In particular, even the least restrictive SSC CIToken may not provide access to all endpoints covered by fcli. If you need access to functionality not covered by CIToken, you may need to define a custom token definition, but this can only be done on self-hosted SSC environments, not on Fortify Hosted. If all else fails, you may need to revert to username/password-based authentication to utilize the short-lived UnifiedLoginToken.

+
+
+

Named Sessions

+
+

Fcli supports named sessions, allowing you to have multiple open sessions for a single product. When issuing a session login command, you can optionally provide a session name as in fcli ssc session login mySession ..., and then use that session in other commands using the --session mySession command line option. If no session name is specified, a session named default will be created/used. Named sessions allow for a variety of use cases, for example:

+
+
+
    +
  • +

    Run fcli commands against multiple instances of the same product, like DEV and PROD instances or an on-premise instance and a Fortify Hosted instance, without having to continuously login and logout from one instance to switch to another instance

    +
    • +
  • +

    Run fcli commands against a single instance of a product, but with alternating credentials, for example with one session providing admin rights and another session providing limited user rights

    +
    • +
  • +

    Run one session with username/password credentials to allow access to all fcli functionality (based on user permissions), and another session with token-based authentication with access to only a subset of fcli functionality

    +
    • +
  • +

    Run multiple pipelines or automation scripts simultaneously, each with their own session name, to reduce chances of these pipelines and scripts affecting each other (see Fcli Data Folder though for a potentially better solution for this scenario)

    +
    • +
+
+
+
+

Session Storage

+
+

To keep session state between fcli invocations, fcli stores session data like URL and authentication tokens in the Fcli Data Folder. To reduce the risk of unauthorized access to this sensitive data, fcli encrypts the session data files. However, this is not bullet-proof, as the default encryption key and algorithm can be easily viewed in fcli source code. As such, it is recommended to ensure file permissions on the fcli data folder are properly configured to disallow access by other users. Being stored in the user’s home directory by default, the correct file permissions should usually already be in place. For enhanced security, you may also consider setting the FCLI_ENCRYPT_KEY environment variable; see the Fcli Data Folder section for details.

+
+
+
+
+
+

Environment Variables

+
+
+

The sections below describe various environment variables that can be used to control fcli behavior. This includes environment variables for overriding some of the default directories used by fcli to store data, and for setting default values for command-line options.

+
+
+

Fcli User Home Folder

+
+

By default, fcli will use the home directory of the current user for various operations, like storing fcli state and configuration (see next section) or for tool installations (see fcli tool manual pages). These locations can be individually overridden through environment variables or command-line options, but in some cases you may want to just specify an alternative 'user home directory' to have all fcli operations use this alternative directory by default, instead of having to override multiple individual directories.

+
+
+

For this purpose, fcli will check for an environment variable named FCLI_USER_HOME; if defined, the value of this environment variable will be used instead of the actual user home directory for any fcli command that reads or writes data from/to the user home directory.

+
+
+

Of course, even if this environment variable is set, you can still override individual directories through the applicable environment variables or command-line options. For example, if you set both FCLI_USER_HOME and FCLI_CONFIG_DIR (but not any of the other environment variables listed in the next section), then fcli configuration data will be stored in the directory specified through FCLI_CONFIG_DIR, whereas fcli state data will be stored in <FCLI_USER_HOME>/.fortify/fcli/state.

+
+
+
+

Fcli Data Storage

+
+

By default, fcli stores configuration and state data like session files (see Session Management), fcli variable contents (see Fcli Variables) and proxy settings in its data folder. Future versions of fcli may also automatically generated log files in this data directory, if no --log-file option is provided.

+
+
+

The locations of these files can be controlled through the following environment variables:

+
+
+
    +
  • +

    FCLI_STATE_DIR: Location of fcli state like session and variable data.
    +Default: <FCLI_DATA_DIR>/state

    +
    • +
  • +

    FCLI_CONFIG_DIR: Location of fcli configuration data like proxy and trust store settings.
    +Default: <FCLI_DATA_DIR>/config

    +
    • +
  • +

    FCLI_DATA_DIR: Default base directory for the two directories listed above.
    +Default: <FORTIFY_DATA_DIR>/fcli

    +
    • +
  • +

    FORTIFY_DATA_DIR: Default base directory for the directories listed above.
    +Default: <user home directory>/.fortify

    +
    • +
+
+
+

If none of these environment variables have been set, then state data will be stored in <user home directory>/.fortify/fcli/state, and configuration data will be stored in <user home directory>/.fortify/fcli/config.

+
+
+

Note: earlier versions of fcli used different environment variable names, but this was causing issues (see Issue 248). If you are using an older fcli version, please refer to the corresponding documentation. When upgrading fcli from an older version, you may need to adjust the environment variable names.

+
+
+

When utilizing fcli in pipelines or automation scripts, especially when multiple pipelines or scripts may be running simultaneously on a single, non-containerized system, it is highly recommended to have each pipeline use a separate fcli state directory, to avoid those pipelines from sharing session data, variables and other persistent fcli state data. This will avoid issues like different pipelines overwriting each others session data (for example with different URLs or credentials), or one pipeline logging out of a session while another pipeline is still using the session.

+
+
+

Depending on the situation, pipelines can either share fcli configuration data, or be configured to have different configuration data directories. When sharing the configuration data, it is recommended that these pipelines do not update any configuration data during pipeline execution, but rather use pre-configured settings. For example, you could pre-configure fcli with proxy and trust store settings.

+
+
+

On containerized systems, like pipelines running in GitLab or GitHub, the default folders will usually be stored inside the individual pipeline containers and thus will not interfere with each others state.

+
+
+

Note that some files stored in the fcli data directory may contain sensitive data, like authentication tokens generated by login commands, or proxy credentials configured through the fcli config proxy commands. Fcli encrypts any sensitive files, but since the encryption key and algorithm are hardcoded, these files can be decrypted fairly easily. You should ensure proper file access permissions on the fcli data folder. In addition, you can consider setting the FCLI_ENCRYPT_KEY environment variable to configure an alternative encryption key. That way, the sensitive files can only be decrypted if someone has access to this custom encryption key.

+
+
+
+

Default Values for CLI options

+
+

Apart from the special-purpose environment variables described in the sections above, fcli allows for specifying default option and parameter values through environment variables. This is particularly useful for specifying product URL’s and credentials through pipeline secrets, but also allows for preventing having to manually supply command line options if you frequently invoke a particular command with the same option value(s). For example, you could define a default value for --issue-template option of the +fcli ssc appversion create option, to avoid having to remember the issue template name every time you invoke this command.

+
+
+

Fcli walks the command tree to find an environment variable that matches a particular option, starting with the most detailed command prefix first. For the issue-template example above, fcli would look for the following environment variable names, in this order:

+
+
+
    +
  • +

    FCLI_DEFAULT_SSC_APPVERSION_CREATE_ISSUE_TEMPLATE

    +
    • +
  • +

    FCLI_DEFAULT_SSC_APPVERSION_ISSUE_TEMPLATE

    +
    • +
  • +

    FCLI_DEFAULT_SSC_ISSUE_TEMPLATE

    +
    • +
  • +

    FCLI_DEFAULT_ISSUE_TEMPLATE

    +
    • +
+
+
+

Environment variable lookups are based on the following rules:

+
+
+
    +
  • +

    Command aliases are not taken into account when looking for environment variables; suppose we have a delete command with alias rm, you will need to use FCLI_DEFAULT_..._DELETE_... and not FCLI_DEFAULT_..._RM_...

    +
    • +
  • +

    For options, fcli will use the longest option name when looking for environment variables; suppose we have an option with names -a, --ab and --abc, you will need to use FCLI_DEFAULT_..._ABC and not FCLI_DEFAULT_..._AB or FCLI_DEFAULT_..._A

    +
    • +
  • +

    For positional parameters, the environment variable name will be based on the parameter label, converted to SNAKE_CASE with all special characters replaced by an underscore. For example, <attributeDefinitionId> will become ATTRIBUTE_DEFINITION_ID, and HOST:PORT will become HOST_PORT.

    +
    • +
+
+
+

Although powerful, these environment variables for providing default option and parameter values should be used with some care to avoid unexpected results:

+
+
+
    +
  1. +

    Obviously command option requirements should be respected; supplying default values for exclusive options may result in errors or unexpected behavior

    +
    2. +
  2. +

    Preferably, you should use the most specific environment variable name, like FCLI_DEFAULT_SSC_APPVERSION_CREATE_ISSUE_TEMPLATE from the example above, to avoid accidentally supplying default values to a similarly named option on other commands

    +
    3. +
+
+
+

Despite #2 above, in some cases it may be useful to use less specific environment names, in particular if the same default values should be applied to multiple commands. As an example, consider an environment variable named FCLI_DEFAULT_SSC_URL:

+
+
+
    +
  • +

    This variable value will be used as a default value for all --url options in the SSC module

    +
    • +
  • +

    This variable value will be used as a default value for all --ssc-url options in other product modules

    +
    • +
+
+
+

This means that defining a single FCLI_DEFAULT_SSC_URL environment variable, together with for example FCLI_DEFAULT_SSC_USER and FCLI_DEFAULT_SSC_PASSWORD environment variables, allows for applying these default values to all of the fcli ssc session login, fcli sc-sast session login, fcli sc-dast session login, and corresponding logout commands.

+
+
+

Note that as described in the –env-prefix section, you can override the FCLI_DEFAULT prefix. For example, with --env-prefix MYPREFIX, fcli will look for MYPREFIX_* environment variables instead of FCLI_DEFAULT_* environment variables.

+
+
+
+
+
+

Fcli Variables

+
+
+

Fcli allows for storing fcli output data in fcli variables for use by subsequent fcli commands. This is a powerful feature that prevents users from having to use shell features to parse fcli output when needing to provide output from one command as input to another command. For example, this feature allows for starting a scan, and then passing the scan id to a corresponding wait-for command, or for creating an SSC application version, and passing the SSC application version id to the artifact upload command.

+
+
+

Variables can be stored using the --store myVarName[:prop1,prop2] option on data output commands. If property names are specified, then only these property names will be stored. If no property names are provided, all available JSON properties will be stored.

+
+
+

Variables can be referenced in subsequent fcli commands using the ::myVarName::prop syntax anywhere on the command line; such occurrences will be substituted with the value of the given property name.

+
+
+

Many (but not all) fcli commands will also store an entity-specific default property name when using the --store option. Whether a default property name has been stored can be seen in the output of the fcli util variable list command. If a default property name was stored, the ::myVarName:: syntax can be used to reference the value of the default property name, thereby avoiding the need to manually specify the appropriate property name.

+
+
+

Following are some examples, assuming the necessary login sessions are available:

+
+
+
+
fcli ssc appversion create myApp:1.0 --auto-required-attrs --skip-if-exists --store myVersion
+fcli ssc artifact upload myScan.fpr --appversion ::myVersion::
+
+fcli ssc appversion create myApp:1.0 --auto-required --skip-if-exists --store myVersion:id,name
+fcli ssc artifact upload myScan.fpr --appversion ::myVersion::id
+
+fcli sc-sast scan start -p package.zip -v 22.2 --appversion test:1.0 --store x
+fcli sc-sast scan wait-for ::x::
+
+fcli sc-sast scan start -p package.zip -v 22.2 --appversion test:1.0 --store x
+fcli sc-sast scan wait-for ::x::jobToken
+
+
+
+

Fcli provides the regular get, list and delete operations on the +fcli util variable command tree, and actual variable contents can be retrieved using the fcli util variable contents command. Please see help output or manual pages for more information on these commands.

+
+
+

The fcli util variable contents command supports the regular fcli output options and query capabilities. This allows for advanced us cases, like retrieving server data once and then outputting it in multiple formats, potentially even applying separate filters. As an example:

+
+
+
+
fcli ssc appversion list --store myVersions
+fcli util variable contents myVersions -o csv --output-to-file myVersions.csv
+fcli util variable contents myVersions -o json -q createdBy=admin --output-to-file myAdminVersions.json
+fcli util variable contents myVersions -o 'expr={id}\n' --output-to-file myVersionIds.txt
+
+
+
+

Note: variable-related syntax and behavior was changed in fcli version 2.0.0. If you are using an older fcli version, please refer to the documentation for that version. When upgrading from 1.x.x to 2.x.x, you may need to update your fcli invocations to match the new syntax. See Issue 160 for information on why syntax and behavior was changed.

+
+
+
+
+

Actions

+
+
+

Fcli actions are a powerful feature that allows for rich integration and automation by running a customizable set of instructions defined in YAML files. These instructions allow for processing data collected from Fortify or third-party products, updating data in those products, and writing output to files or console.

+
+
+

Built-in Actions

+
+

Fci comes with various built-in actions, currently focused on providing the following functionality:

+
+
+
    +
  • +

    Vulnerability export to various third-party formats like SARIF or GitHub, GitLab, BitBucket, and SonarQube reports, as a replacement for FortifyVulnerabilityExporter.

    +
    • +
  • +

    Generating GitHub Pull Request comments, listing (re-)introduced and removed vulnerabilities.

    +
    • +
  • +

    Generating application version/release summaries in Markdown format, for example for use as pipeline summaries.

    +
    • +
  • +

    Evaluating security policy criteria, for example allowing to break a build if one or more checks are failing.

    +
    • +
+
+
+

Documentation for built-in actions can be found here:

+
+
+ +
+
+

Future fcli versions may introduce new built-in actions, enhance existing built-in actions, or provide enhanced action syntax, for example to allow for running pipeline-style actions that run a set of commands to package source code, submit a scan request, wait for scan completion, and perform post-scan activities like data export or policy checks.

+
+
+

Action support is centralized into the action entity of the various product modules. For now, fcli supports fcli fod action * and fcli ssc action * commands. Based on user feedback, we may consider adding action support on other modules like sc-sast or sc-dast as well. The following commands may be used to manage and run built-in actions:

+
+
+
    +
  • +

    fcli * action list: List available built-in actions (and imported custom actions, see next section).

    +
    • +
  • +

    fcli * action help <action>: Display action usage information like description and list of action-specific command-line options.

    +
    • +
  • +

    fcli * action get <action>: Display action YAML contents.

    +
    • +
  • +

    fcli * action run <action>: Run a given action.

    +
    • +
+
+
+
+

Custom Actions

+
+

Apart from built-in actions, users can also develop and run custom actions, which could be customized versions of built-in actions or completely new actions. Note that the ability to run custom actions is currently considered PREVIEW functionality; as fcli actions are a new functionality, we are collecting user feedback regarding action syntax, which could potentially result in breaking action syntax changes across minor fcli releases (although we’ll try to avoid this as much as possible).

+
+
+

As such, custom actions that run fine on the current fcli version may fail to run on any other fcli version. Fcli does perform action version checks based on action schema version (see below), but supported schema versions may change between minor or patch releases of fcli. Once we are comfortable with moving custom actions out of PREVIEW status, breaking schema/action syntax changes will be allowed only on major fcli releases, for example when moving from fcli 2.x to fcli 3.x.

+
+
+

Custom actions can be loaded from various sources, like a local or remote YAML file, optionally embedded in a zip-file that contains multiple actions. Each of the fcli commands listed in the previous section also support custom actions:

+
+
+
    +
  • +

    fcli * action list --from-zip <file|url>: List available actions from the given zip-file.

    +
    • +
  • +

    fcli * action help|get|run <file|url>: Load the action from the given file or URL.

    +
    • +
  • +

    fcli * action help|get|run <action> --from-zip <file|url>: Load the given action from the given zip-file.

    +
    • +
+
+
+

To allow for easy access, custom actions can also be imported into fcli using the fcli * action import command, which allows for importing either a single action YAML file or all action YAML files from a local or remote zip-file. Once imported, these actions can be accessed in the same way as built-in actions. Note that imported custom actions will override built-in actions if they have the same name. You can use the fcli * action reset command to remove all previously imported custom actions.

+
+
+
+

Custom Action Development

+
+

There are several resources available to help you developing custom actions. To start with, you can use the fcli * action get <action> command to view the contents of any built-in action as a basis for developing your own custom actions. Fcli provides a built-in __sample__ action that explains various concepts and lists many of the supported action YAML elements together with a description. To view the sample action, use the fcli ssc action get __sample__ or fcli fod action get __sample__ command.

+
+
+

Fcli also provides an action schema, which allows YAML editors and IDEs to provide code completion, documentation and validation for fcli action YAML documents. You may need to install a plugin to enable proper YAML editing and schema support. Following are some commonly used IDE plugins that are known to work with one of the schema associations listed below:

+
+
+ +
+
+

For optimal compatibility with various IDEs and YAML editors, fcli allows the schema to be declared in two ways:

+
+
+
    +
  • +

    YAML comment, supported by IDEs like Visual Studio Code, Eclipse and IntelliJ:

    +
    +
    +
    # yaml-language-server: $schema=https://fortify.github.io/fcli/schemas/action/fcli-action-schema-1.1.0.json
    +
    +
    +
    • +
  • +

    YAML property, supported by Eclipse and some other YAML editors:

    +
    +
    +
    $schema: https://fortify.github.io/fcli/schemas/action/fcli-action-schema-1.1.0.json
    +
    +
    +
    • +
+
+
+

Fcli requires at least one of these statements to be provided in action YAML files. You may also provide both, in which case the schema URL must be identical in both statements. Once you’ve added one of these statements to your action YAML file, your IDE or YAML editor may automatically provide support for editing and validating action YAML files. If not, try closing and re-opening the YAML file, or consult the documentation of your IDE or YAML editor.

+
+
+

As shown in the sample schema statements above, the current fcli version 2.10.1 supports schema version 1.1.0. Other fcli versions may support different schema versions. In general, fcli also provides backward compatibility for earlier schema versions with the same schema major version range, and forward compatibility for later schema patch versions within the same schema minor version range.

+
+
+
+

Security Considerations

+
+

As actions can potentially perform dangerous operations, like sending confidential data to third-party systems, or updating or deleting data in Fortify or third-party systems, you should only run trusted actions. If you wish to run any actions provided by a third party, you could potentially review action contents, and potentially in the future we may provide functionality for performing a security analysis on action contents (either as a new fcli command or through Fortify rules).

+
+
+

However, this won’t be sufficient for actions that are dynamically loaded from a remote location, as action contents could change at any time. For example, a legitimate action can easily be replaced by some malicious action.

+
+
+

For this reason, fcli by default requires custom actions to be signed. Organizations, teams or individuals can sign actions with their own private key using the fcli * action sign command, the corresponding public key can be imported into fcli using the fcli config public-key import command. Most action commands also allow for explicitly passing a public key through the --pubkey option.

+
+
+

Public keys can be loaded from a local file, URL, string or environment variable, see command help or next section for details. Obviously, you should only use trusted public keys; loading a public key from a third-party URL may be dangerous for the same reasons as explained above.

+
+
+
+

Actions in CI/CD pipelines

+
+

Fcli is commonly used in CI/CD pipelines to perform all sorts of Fortify-related operations, and fcli actions allow for even more advanced use cases. This section provides some hints as to how to integrate actions into CI/CD pipelines, considering deployment and security aspects.

+
+
+

Publishing

+
+
+

Fcli actions can be loaded from any URL, but for CI/CD integration you could consider hosting fcli actions in a shared source code repository like https://some-scm.our.org/repositories/shared-ci-tools/fcli/actions. This allows for easy sharing and maintainance of fcli actions that are used across many CI/CD pipelines. This even allows for automatically signing those action using CI/CD pipelines on this shared repository.

+
+
+

Public & private key management

+
+
+

Of course, those actions should be signed using an organization-specific private key. For example, this could be either an existing private key that’s used throughout the organization, or a private key that’s managed by the CI/CD team. There are several ways to pass the corresponding public key to fcli from within CI/CD pipelines:

+
+
+
    +
  • +

    Explicitly run fcli config public-key import command from each pipeline before running any actions.

    +
    • +
  • +

    Explicitly pass the --pubkey option on any fcli * action run commands.

    +
    • +
  • +

    Set the FCLI_DEFAULT_PUBKEY environment variable to configure a default value for the --pubkey option.

    +
    • +
+
+
+

With each of these approaches, the public key can be be loaded from:

+
+
+
    +
  • +

    Local file, for example public key stored in current source code repository.

    +
    • +
  • +

    URL, for example pointing to public key stored in same shared source code repository as the actions themselves.

    +
    • +
  • +

    Environment variable, for example defined as system environment variable on self-hosted CI/CD nodes, or configured through (global) CI/CD secrets/variables.

    +
    • +
  • +

    Plain string, for example having the environment variable FCLI_DEFAULT_PUBKEY set to string:<public key contents>. You can use CI/CD secrets/variables to set the FCLI_DEFAULT_PUBKEY to a value like this. For testing, you can use a bash command like the following: export FCLI_DEFAULT_PUBKEY=string:$(cat my-public.key).

    +
    • +
+
+
+

Design considerations

+
+
+

Given that actions can define and process arbitrary parameters, it may be tempting to implement generic, highly configurable actions. For example, you could implement a highly configurable action for checking all kinds of security policy criteria, with the actual criteria to be checked being passed as action parameters.

+
+
+

However, from a CI/CD perspective, this means that every pipeline must properly set these action parameters. Pipeline authors may copy existing pipelines or use pipeline templates to have these action parameters set to predefined values, but what if those parameters need to updated globally? Potentially, this means that you’d need to update thousands of pipelines to adjust action parameters.

+
+
+

This is exactly the reason why we don’t provide a highly configurable check-policy action, but instead just provide an example that can be customized according to organization requirements. Instead of passing fine-grained pass/fail criteria as action parameters, those criteria are hard-coded into the action. If there is a need to apply different criteria for different types of applications, for example based on business risk, multiple approaches are possible:

+
+
+
    +
  • +

    Use SSC/FoD application version/release attributes like Business Risk or other characteristics to identify what criteria to apply. This is the preferred approach, to allow the criteria to be applied to automatically match the centrally maintained attributes/characteristics.

    +
    • +
  • +

    Have the action take one or more parameters that identify what criteria to apply. This could be a policy name, or a functional identifier like --business-risk.

    +
    • +
  • +

    Publish separate actions that implement different policy criteria, like check-high-risk-policy and check-low-risk-policy.

    +
    • +
+
+
+

The examples above or based on actions that perform policy checks, but the same principles and considerations (may) apply to other types of actions.

+
+
+
+
+
+

Manual Pages

+
+
+

Manual pages are automatically generated and contain mostly the same information as fcli help output. Manual pages for the current version of this documentation can be accessed here: fcli (1).

+
+
+

Some important notes:

+
+
+
    +
  • +

    Please make sure that you’re viewing the correct documentation for the fcli version that you’re using:

    +
    +
      +
    • +

      When viewing offline documentation (docs-html.zip downloaded from fcli releases page), make sure that you downloaded the correct version.

      +
      • +
    • +

      When viewing online documentation at fortify.github.io, make sure that the drop-down menu on the top-right is showing the correct fcli version.

      +
      • +
    +
    +
    • +
  • +

    If you are viewing an offline copy of this documentation, the manual pages link above will likely only work if you extracted the full zip-file to a local directory.

    +
    • +
  • +

    In some cases, fcli help output may show more details than the manual pages, if those details are only available at runtime.

    +
    +
      +
    • +

      A notable example are the various states that may be referenced in wait-for commands; these states are not listed in the manual pages but can be viewed by running fcli <product> <entity> wait-for -h.

      +
      • +
    +
    +
    • +
+
+
+
+
+

Troubleshooting

+
+
+

Native Binaries

+
+

Native binaries require some special source code annotations for proper operation, which are not required for the plain Java .jar version of fcli. If fcli developers forgot to include any of these annotations, you +may experience any of the following behavior:

+
+
+
    +
  • +

    Commands and/or option listed in manual pages are not listed by the help output of a native binary

    +
    • +
  • +

    Trying to use commands and/or options listed in the manual pages result in errors stating that the command or option is not recognized

    +
    • +
  • +

    Some commands and/or options result in technical error messages about classes, constructors or methods not being found or not being accessible

    +
    • +
+
+
+

If you encounter any of these issues, please submit a bug report as described in Submitting a Bug Report. As described in that section, please include information on whether the .jar version of fcli exhibits the same erroneous behavior. While fcli developers are working on fixing the issue, you can temporarily use the .jar version of fcli until the issue is resolved.

+
+
+
+

Submitting a Bug Report

+
+

After confirming that an issue cannot be resolved based on the information above, and is not caused by user error, please consider submitting a bug report on the fcli issue tracker. Before doing so, please verify that there is not already a bug report open for the issue that you are experiencing; in that case, feel free to leave a comment on the existing bug report to confirm the issue and/or provide additional details.

+
+
+

When opening a bug report, please include the following information:

+
+
+
    +
  • +

    Fcli version, as shown by the fcli --version command

    +
    • +
  • +

    Which fcli variant you are using; one of the native binaries or the .jar variant invoked using java -jar fcli.jar

    +
    • +
  • +

    If you are experiencing an issue with the native binaries, please confirm whether the .jar version of fcli exhibits the same behavior

    +
    • +
  • +

    Operating system and any other relevant environment details, for example:

    +
    +
      +
    • +

      Interactive or pipeline/automation use

      +
      • +
    • +

      If pipeline use, what CI/CD system are you running fcli on (Jenkins, GitHub, GitLab, …)

      +
      • +
    • +

      What FCLI environment variables have been set

      +
      • +
    +
    +
    • +
  • +

    Steps to reproduce

    +
    • +
  • +

    Any other information that may be relevant

    +
    • +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-clear.html b/v2.10.1/manpage/fcli-config-clear.html new file mode 100644 index 000000000..2a9813fae --- /dev/null +++ b/v2.10.1/manpage/fcli-config-clear.html @@ -0,0 +1,126 @@ +--- +title: fcli-config-clear(1) +fcli_version: +--- + + + + + + + +fcli-config-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config clear [-y] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command deletes the fcli configuration directory, clearing configuration settings like language, proxy and trust store settings. Note that this does not clear current fcli state, like session and variable data; please use the 'fcli util state clear' command for clearing state data.

+
+
+
+
+

Options

+
+
+
+
-y, --confirm
+
+

Confirm deleting all fcli configuration settings.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy-add.html b/v2.10.1/manpage/fcli-config-proxy-add.html new file mode 100644 index 000000000..ce36b8e84 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy-add.html @@ -0,0 +1,168 @@ +--- +title: fcli-config-proxy-add(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy-add(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy add [-p[=<proxyPassword>]] [--name=<name>] + [--priority=<priority>] [-u=<proxyUser>] [-m=<modules>[, + <modules>…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-i=<includedHosts>[,<includedHosts>…​] + [-i=<includedHosts>[,<includedHosts>…​]]…​ | + -e=<excludedHosts>[,<excludedHosts>…​] + [-e=<excludedHosts>[,<excludedHosts>…​]]…​] HOST:PORT

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-e, --exclude-hosts=<excludedHosts>[,<excludedHosts>…​]
+
+

Comma-separated list of target host names on which not to apply this proxy configuration. Host names may include wildcard characters, like *.myintra.net.

+
+
-i, --include-hosts=<includedHosts>[,<includedHosts>…​]
+
+

Comma-separated list of target host names on which to apply this proxy configuration. Host names may include wildcard characters, like *.fortifyhosted.net.

+
+
-m, --modules=<modules>[,<modules>…​]
+
+

Comma-separated list of fcli modules / target systems (fod, sc-dast, sc-sast, ssc, debricked, tool) on which to apply this proxy configuration.

+
+
--name=<name>
+
+

Name for the proxy configuration to be added; defaults to <proxy host>:<proxy port>.

+
+
-p, --password[=<proxyPassword>]
+
+

Password used to authenticate with the proxy server.

+
+
--priority=<priority>
+
+

Priority of this proxy configuration. If multiple configuration match the target module & URL, the proxy configuration with highest priority is used.

+
+
-u, --user=<proxyUser>
+
+

Username used to authenticate with the proxy server.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
HOST:PORT
+
+

Proxy host and port in the format <proxy host>:<proxy port>.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy-clear.html b/v2.10.1/manpage/fcli-config-proxy-clear.html new file mode 100644 index 000000000..a13059ade --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy-clear.html @@ -0,0 +1,110 @@ +--- +title: fcli-config-proxy-clear(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy clear [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy-delete.html b/v2.10.1/manpage/fcli-config-proxy-delete.html new file mode 100644 index 000000000..a138edf45 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy-delete.html @@ -0,0 +1,124 @@ +--- +title: fcli-config-proxy-delete(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy delete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] NAME

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
NAME
+
+

Name of the proxy configuration to be deleted.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy-list.html b/v2.10.1/manpage/fcli-config-proxy-list.html new file mode 100644 index 000000000..2f524e74d --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy-list.html @@ -0,0 +1,124 @@ +--- +title: fcli-config-proxy-list(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy-update.html b/v2.10.1/manpage/fcli-config-proxy-update.html new file mode 100644 index 000000000..6a76c68b0 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy-update.html @@ -0,0 +1,169 @@ +--- +title: fcli-config-proxy-update(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy update [-p[=<proxyPassword>]] [--priority=<priority>] + [--proxy=<proxyHostAndPort>] [-u=<proxyUser>] + [-m=<modules>[,<modules>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-i=<includedHosts>[, + <includedHosts>…​] [-i=<includedHosts>[, + <includedHosts>…​]]…​ | -e=<excludedHosts>[, + <excludedHosts>…​] [-e=<excludedHosts>[, + <excludedHosts>…​]]…​] NAME

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-e, --exclude-hosts=<excludedHosts>[,<excludedHosts>…​]
+
+

Comma-separated list of target host names on which not to apply this proxy configuration. Host names may include wildcard characters, like *.myintra.net.

+
+
-i, --include-hosts=<includedHosts>[,<includedHosts>…​]
+
+

Comma-separated list of target host names on which to apply this proxy configuration. Host names may include wildcard characters, like *.fortifyhosted.net.

+
+
-m, --modules=<modules>[,<modules>…​]
+
+

Comma-separated list of fcli modules / target systems (fod, sc-dast, sc-sast, ssc, debricked, tool) on which to apply this proxy configuration.

+
+
-p, --password[=<proxyPassword>]
+
+

Password used to authenticate with the proxy server.

+
+
--priority=<priority>
+
+

Priority of this proxy configuration. If multiple configuration match the target module & URL, the proxy configuration with highest priority is used.

+
+
--proxy=<proxyHostAndPort>
+
+

Proxy host and port in the format <proxy host>:<proxy port>.

+
+
-u, --user=<proxyUser>
+
+

Username used to authenticate with the proxy server.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
NAME
+
+

Name of the proxy configuration to be updated.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-proxy.html b/v2.10.1/manpage/fcli-config-proxy.html new file mode 100644 index 000000000..03dd62ad8 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-proxy.html @@ -0,0 +1,103 @@ +--- +title: fcli-config-proxy(1) +fcli_version: +--- + + + + + + + +fcli-config-proxy(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config proxy [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
add
+
+

Add a proxy configuration.

+
+
clear
+
+

Clear all proxy configurations.

+
+
delete, rm
+
+

Delete a proxy configuration.

+
+
list, ls
+
+

List proxy configurations.

+
+
update
+
+

Update a proxy configuration.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key-clear.html b/v2.10.1/manpage/fcli-config-public-key-clear.html new file mode 100644 index 000000000..7acf45c70 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key-clear.html @@ -0,0 +1,124 @@ +--- +title: fcli-config-public-key-clear(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key clear [-y] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-y, --confirm
+
+

Confirm clearing all trusted public keys.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key-delete.html b/v2.10.1/manpage/fcli-config-public-key-delete.html new file mode 100644 index 000000000..a6930bde0 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key-delete.html @@ -0,0 +1,125 @@ +--- +title: fcli-config-public-key-delete(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key delete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <nameOrFingerprint>

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<nameOrFingerprint>
+
+

Public key name or fingerprint.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key-get.html b/v2.10.1/manpage/fcli-config-public-key-get.html new file mode 100644 index 000000000..b225e4fd0 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key-get.html @@ -0,0 +1,125 @@ +--- +title: fcli-config-public-key-get(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key get [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <nameOrFingerprint>

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<nameOrFingerprint>
+
+

Public key name or fingerprint.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key-import.html b/v2.10.1/manpage/fcli-config-public-key-import.html new file mode 100644 index 000000000..92005f209 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key-import.html @@ -0,0 +1,163 @@ +--- +title: fcli-config-public-key-import(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key import -n=<name> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] source

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-n, --name=<name>
+
+

Name for the imported public key.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
source
+
+

Public key to be imported into the fcli trusted public key store. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only import trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted.
+
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key-list.html b/v2.10.1/manpage/fcli-config-public-key-list.html new file mode 100644 index 000000000..6b3fd321c --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key-list.html @@ -0,0 +1,125 @@ +--- +title: fcli-config-public-key-list(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-public-key.html b/v2.10.1/manpage/fcli-config-public-key.html new file mode 100644 index 000000000..615b06af5 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-public-key.html @@ -0,0 +1,103 @@ +--- +title: fcli-config-public-key(1) +fcli_version: +--- + + + + + + + +fcli-config-public-key(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config public-key [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
clear
+
+

Clear all trusted public keys.

+
+
delete, rm
+
+

Delete a trusted public key.

+
+
get
+
+

Get trusted public key data.

+
+
list, ls
+
+

List trusted public keys.

+
+
import
+
+

Import a trusted public key.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-truststore-clear.html b/v2.10.1/manpage/fcli-config-truststore-clear.html new file mode 100644 index 000000000..fe1e6952c --- /dev/null +++ b/v2.10.1/manpage/fcli-config-truststore-clear.html @@ -0,0 +1,110 @@ +--- +title: fcli-config-truststore-clear(1) +fcli_version: +--- + + + + + + + +fcli-config-truststore-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config truststore clear [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-truststore-get.html b/v2.10.1/manpage/fcli-config-truststore-get.html new file mode 100644 index 000000000..2b9cefcd1 --- /dev/null +++ b/v2.10.1/manpage/fcli-config-truststore-get.html @@ -0,0 +1,110 @@ +--- +title: fcli-config-truststore-get(1) +fcli_version: +--- + + + + + + + +fcli-config-truststore-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config truststore get [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-truststore-set.html b/v2.10.1/manpage/fcli-config-truststore-set.html new file mode 100644 index 000000000..965fa669e --- /dev/null +++ b/v2.10.1/manpage/fcli-config-truststore-set.html @@ -0,0 +1,134 @@ +--- +title: fcli-config-truststore-set(1) +fcli_version: +--- + + + + + + + +fcli-config-truststore-set(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config truststore set -f=<file> [-p=<trustStorePassword>] + [-t=<trustStoreType>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Path to custom SSL trust store file.

+
+
-p, --password=<trustStorePassword>
+
+

Optional SSL trust store password.

+
+
-t, --type=<trustStoreType>
+
+

SSL trust store type (jks, pkcs12).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config-truststore.html b/v2.10.1/manpage/fcli-config-truststore.html new file mode 100644 index 000000000..0218e0c8b --- /dev/null +++ b/v2.10.1/manpage/fcli-config-truststore.html @@ -0,0 +1,95 @@ +--- +title: fcli-config-truststore(1) +fcli_version: +--- + + + + + + + +fcli-config-truststore(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config truststore [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
clear
+
+

Clear SSL trust store configuration to use default trust store.

+
+
get
+
+

Get current SSL trust store configuration.

+
+
set
+
+

Configure SSL trust store.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-config.html b/v2.10.1/manpage/fcli-config.html new file mode 100644 index 000000000..3c5dd71d7 --- /dev/null +++ b/v2.10.1/manpage/fcli-config.html @@ -0,0 +1,101 @@ +--- +title: fcli-config(1) +fcli_version: +--- + + + + + + + +fcli-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli config [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for managing configuration settings that may apply to multiple fcli modules. For example, this includes commands for managing proxy settings to allow fcli to connect to remote systems through a proxy server, and for configuring SSL trust store settings to allow fcli to connect to servers with self-signed certificates.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
clear
+
+

Clear full fcli configuration.

+
+
proxy
+
+

Manage fcli proxy configurations.

+
+
public-key, pubkey
+
+

Manage fcli trusted public keys.

+
+
truststore
+
+

Manage fcli trust store configuration.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-create-group.html b/v2.10.1/manpage/fcli-fod-access-control-create-group.html new file mode 100644 index 000000000..21735ad14 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-create-group.html @@ -0,0 +1,167 @@ +--- +title: fcli-fod-access-control-create-group(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-create-group(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control create-group [--add-all-users] + [--applications=<applications>[, + <applications>…​]]…​ [--users=<users>[, + <users>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] <groupName>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--add-all-users
+
+

Add all tenant users to the user group.

+
+
--applications=<applications>[,<applications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--users=<users>[,<users>…​]
+
+

One or more comma-separated user id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<groupName>
+
+

The name of the user group.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-create-user.html b/v2.10.1/manpage/fcli-fod-access-control-create-user.html new file mode 100644 index 000000000..78fbd8830 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-create-user.html @@ -0,0 +1,187 @@ +--- +title: fcli-fod-access-control-create-user(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-create-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control create-user --email=<email> --firstname=<firstName> + --lastname=<lastName> + [--phone=<phoneNumber>] + --role=<roleNameOrId> + [--applications=<applications>[, + <applications>…​]]…​ + [--groups=<userGroups>[, + <userGroups>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <userName>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--applications=<applications>[,<applications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--email=<email>
+
+

The email address of the user.

+
+
--firstname=<firstName>
+
+

The first name of the user.

+
+
--groups=<userGroups>[,<userGroups>…​]
+
+

One or more comma-separated group id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--lastname=<lastName>
+
+

The last name of the user.

+
+
--phone, --phone-number=<phoneNumber>
+
+

The phone number of the user.

+
+
--role=<roleNameOrId>
+
+

The id or name of the role the user should be given.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userName>
+
+

The username of the user.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-delete-group.html b/v2.10.1/manpage/fcli-fod-access-control-delete-group.html new file mode 100644 index 000000000..19022ad3a --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-delete-group.html @@ -0,0 +1,142 @@ +--- +title: fcli-fod-access-control-delete-group(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-delete-group(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control delete-group [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] + <userGroupNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userGroupNameOrId>
+
+

Group id or name. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-delete-user.html b/v2.10.1/manpage/fcli-fod-access-control-delete-user.html new file mode 100644 index 000000000..9cb66b88f --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-delete-user.html @@ -0,0 +1,141 @@ +--- +title: fcli-fod-access-control-delete-user(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-delete-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control delete-user [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <userNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userNameOrId>
+
+

User id or username. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-get-group.html b/v2.10.1/manpage/fcli-fod-access-control-get-group.html new file mode 100644 index 000000000..9251499cf --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-get-group.html @@ -0,0 +1,141 @@ +--- +title: fcli-fod-access-control-get-group(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-get-group(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control get-group [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <userGroupNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userGroupNameOrId>
+
+

Group id or name. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-get-user.html b/v2.10.1/manpage/fcli-fod-access-control-get-user.html new file mode 100644 index 000000000..fee1f4e36 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-get-user.html @@ -0,0 +1,141 @@ +--- +title: fcli-fod-access-control-get-user(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-get-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control get-user [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <userNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userNameOrId>
+
+

User id or username. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-list-groups.html b/v2.10.1/manpage/fcli-fod-access-control-list-groups.html new file mode 100644 index 000000000..a3be32002 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-list-groups.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-access-control-list-groups(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-list-groups(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control list-groups [--filters-param=<filtersParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-list-roles.html b/v2.10.1/manpage/fcli-fod-access-control-list-roles.html new file mode 100644 index 000000000..f211cab05 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-list-roles.html @@ -0,0 +1,141 @@ +--- +title: fcli-fod-access-control-list-roles(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-list-roles(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control list-roles [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-list-users.html b/v2.10.1/manpage/fcli-fod-access-control-list-users.html new file mode 100644 index 000000000..03b864d2f --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-list-users.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-access-control-list-users(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-list-users(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control list-users [--filters-param=<filtersParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-update-group.html b/v2.10.1/manpage/fcli-fod-access-control-update-group.html new file mode 100644 index 000000000..4144416c3 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-update-group.html @@ -0,0 +1,190 @@ +--- +title: fcli-fod-access-control-update-group(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-update-group(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control update-group [--add-all-users] [--remove-all-users] + [--name=<newName>] + [--add-apps=<addApplications>[, + <addApplications>…​]]…​ + [--add-users=<addUsers>[, + <addUsers>…​]]…​ + [--remove-apps=<removeApplications>[, + <removeApplications>…​]]…​ + [--remove-users=<removeUsers>[, + <removeUsers>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] + <userGroupNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--add-all-users
+
+

Add all tenant users to the user group.

+
+
--add-apps, --add-applications=<addApplications>[,<addApplications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--add-users=<addUsers>[,<addUsers>…​]
+
+

One or more comma-separated user id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--name=<newName>
+
+

The updated name of the user group.

+
+
--remove-all-users
+
+

Remove all tenant users from the user group.

+
+
--remove-apps, --remove-applications=<removeApplications>[,<removeApplications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--remove-users=<removeUsers>[,<removeUsers>…​]
+
+

One or more comma-separated user id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userGroupNameOrId>
+
+

Group id or name. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control-update-user.html b/v2.10.1/manpage/fcli-fod-access-control-update-user.html new file mode 100644 index 000000000..ed8881fb4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control-update-user.html @@ -0,0 +1,218 @@ +--- +title: fcli-fod-access-control-update-user(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control-update-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control update-user [--must-change] [--password-never-expires] + [--suspended] [--email=<email>] + [--firstname=<firstName>] + [--lastname=<lastName>] + [--password=<password>] + [--phone=<phoneNumber>] + [--role=<roleNameOrId>] + [--add-apps=<addApplications>[, + <addApplications>…​]]…​ + [--add-groups=<addUserGroups>[, + <addUserGroups>…​]]…​ + [--remove-apps=<removeApplications>[, + <removeApplications>…​]]…​ + [--remove-groups=<removeUserGroups>[, + <removeUserGroups>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <userNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--add-apps, --add-applications=<addApplications>[,<addApplications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--add-groups=<addUserGroups>[,<addUserGroups>…​]
+
+

One or more comma-separated group id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--email=<email>
+
+

The updated email address of the user.

+
+
--firstname=<firstName>
+
+

Updated first name of the user.

+
+
--lastname=<lastName>
+
+

Updated last name of the user.

+
+
--must-change
+
+

Set a flag to indicate that user’s password must be changed on next login.

+
+
--password=<password>
+
+

Updated user password.

+
+
--password-never-expires
+
+

Set a flag to indicate that the user’s password will never expire.

+
+
--phone, --phone-number=<phoneNumber>
+
+

Updated phone number of the user.

+
+
--remove-apps, --remove-applications=<removeApplications>[,<removeApplications>…​]
+
+

One or more comma-separated application id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--remove-groups=<removeUserGroups>[,<removeUserGroups>…​]
+
+

One or more comma-separated group id’s or name’s. Note that numeric values are always interpreted as id’s. If you have numeric group names, you will need to specify the group id. This functionality will likely be moved to a different command in an upcoming minor fcli release, potentially affecting any workflows in which this option is being used.

+
+
--role=<roleNameOrId>
+
+

Updated id or name of the role the user should be given.

+
+
--suspended
+
+

Suspend the user.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<userNameOrId>
+
+

User id or username. Note that numeric values are always interpreted as id’s. If you have numeric user names, you will need to specify the user id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-access-control.html b/v2.10.1/manpage/fcli-fod-access-control.html new file mode 100644 index 000000000..b10b90688 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-access-control.html @@ -0,0 +1,127 @@ +--- +title: fcli-fod-access-control(1) +fcli_version: +--- + + + + + + + +fcli-fod-access-control(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod access-control [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list-roles, lsr
+
+

List user roles.

+
+
list-groups, lsg
+
+

List user groups.

+
+
get-group
+
+

Get user group details.

+
+
create-group
+
+

Create a new user group.

+
+
update-group
+
+

Update a user group.

+
+
delete-group, rm-group
+
+

Delete a user group.

+
+
list-users, lsu
+
+

List users.

+
+
get-user
+
+

Get user details.

+
+
create-user
+
+

Create a new user.

+
+
update-user
+
+

Update a user.

+
+
delete-user, rm-user
+
+

Delete a user.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-get.html b/v2.10.1/manpage/fcli-fod-action-get.html new file mode 100644 index 000000000..c8cfcc911 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-get.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-action-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action get [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>

+
+
+
+
+

Description

+
+
+

This command allows for listing the YAML contents of built-in or custom actions. This allows for reviewing the operations performed by an action, or for using the action contents as a basis for developing custom actions.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-help.html b/v2.10.1/manpage/fcli-fod-action-help.html new file mode 100644 index 000000000..060fb2baa --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-help.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-action-help(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-help(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action help [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>

+
+
+
+
+

Description

+
+
+

This command allows for showing the help information for the given built-in or custom action. The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-import.html b/v2.10.1/manpage/fcli-fod-action-import.html new file mode 100644 index 000000000..69880f6c5 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-import.html @@ -0,0 +1,192 @@ +--- +title: fcli-fod-action-import(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action import [--on-invalid-signature=<onInvalidSignature>] + [--on-invalid-version=<onUnsupportedVersion>] + [--on-no-public-key=<onNoPublicKey>] + [--on-unsigned=<onUnsigned>] [--pubkey=source] + [-z=<source>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [<action>]

+
+
+
+
+

Description

+
+
+

Import one or more custom actions. You can import either a single action YAML file, or a zip-file containing one or more action YAML files. Imported actions will take precedence over built-in action if they have the same name.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location. If only --from-zip is specified, all actions from that zip-file will be imported.

+
+
+
+
+

Options

+
+
+
+
--on-invalid-signature=<onInvalidSignature>
+
+

Action to take if action signature is invalid. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-invalid-version=<onUnsupportedVersion>
+
+

Action to take if action schema version is not supported by this fcli version. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-no-public-key=<onNoPublicKey>
+
+

Action to take if no matching public key was found. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-unsigned=<onUnsigned>
+
+

Action to take if action isn’t signed. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
[<action>]
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-list.html b/v2.10.1/manpage/fcli-fod-action-list.html new file mode 100644 index 000000000..8297e19d0 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-list.html @@ -0,0 +1,131 @@ +--- +title: fcli-fod-action-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action list [-z=<source>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

By default, this command lists available built-in and previously imported custom actions. If the --from-zip option is specified, this command lists available actions from the given local or remote zip file instead.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-reset.html b/v2.10.1/manpage/fcli-fod-action-reset.html new file mode 100644 index 000000000..f6a6c0a71 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-reset.html @@ -0,0 +1,112 @@ +--- +title: fcli-fod-action-reset(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-reset(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action reset [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

Remove all previously imported custom actions, restoring fcli configuration to provide the default built-in actions only.

+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-run.html b/v2.10.1/manpage/fcli-fod-action-run.html new file mode 100644 index 000000000..a156c1d80 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-run.html @@ -0,0 +1,193 @@ +--- +title: fcli-fod-action-run(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-run(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action run [action-parameters]…​ + [--on-invalid-signature=<onInvalidSignature>] + [--on-invalid-version=<onUnsupportedVersion>] + [--on-no-public-key=<onNoPublicKey>] + [--on-unsigned=<onUnsigned>] [--progress=<type>] + [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + <action>

+
+
+
+
+

Description

+
+
+

This command allows for running built-in or custom actions. As actions may perform potentially dangerous operations like deleting data or posting data to 3rd-party systems, you should only run trusted actions. For this reason, fcli requires confirmation when attempting to run an action without a (valid) signature.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
action-parameters
+
+

Action parameter(s); see 'help' command output to list supported parameters.

+
+
--on-invalid-signature=<onInvalidSignature>
+
+

Action to take if action signature is invalid. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-invalid-version=<onUnsupportedVersion>
+
+

Action to take if action schema version is not supported by this fcli version. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-no-public-key=<onNoPublicKey>
+
+

Action to take if no matching public key was found. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-unsigned=<onUnsigned>
+
+

Action to take if action isn’t signed. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli fod action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action-sign.html b/v2.10.1/manpage/fcli-fod-action-sign.html new file mode 100644 index 000000000..8d4b7cd8b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action-sign.html @@ -0,0 +1,167 @@ +--- +title: fcli-fod-action-sign(1) +fcli_version: +--- + + + + + + + +fcli-fod-action-sign(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action sign [-y] [-p[=<privateKeyPassword>]] --in=<actionFileToSign> + [--info=<extraInfoPath>] --out=<signedActionFile> + [--pubout=<publicKeyPath>] [--signer=<signer>] + --with=<privateKeyPath> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command allows for signing custom actions, allowing those actions to be run without confirmation if the corresponding public key has been imported through the fcli config public-key import command or passed in the --pubkey option on various action commands. The action to be signed must be a local file.

+
+
+

This command can use an existing private key for signing, or generate a new key pair if the private key file as specified through the --with option doesn’t yet exist and --pubout is specified to output the corresponding public key.

+
+
+

Private keys may also be generated using OpenSSL or similar tools, but note that only RSA keys in PEM format are supported, and only a small set of encryption schemes are supported for encrypted private keys. It is recommended to use AES encryption, which is supported by both native fcli executables and the .jar version of fcli. The latter requires Java 19 or above though to handle AES-encrypted private keys. Following is a sample OpenSSL command for generating an encrypted private key that’s supported by fcli for signing: + openssl genpkey -algorithm rsa -out private-key.pem -aes256

+
+
+

For convenience, when using a pre-existing private key, the --pubout option allows for outputting the corresponding public key for use by the fcli config public-key import command. Note that public keys will not be automatically added to the fcli trusted public key store; even if this command generates a key pair on the fly, you’ll still need to import the generated public key using the fcli config public-key import command.

+
+
+
+
+

Options

+
+
+
+
--in=<actionFileToSign>
+
+

Action YAML file to sign.

+
+
--info=<extraInfoPath>
+
+

YAML file containing informational properties to be added to signature metadata. For example, this can be used to document where the public key can be retrieved from, or some extra information about the action being signed.

+
+
--out=<signedActionFile>
+
+

Signed action output file.

+
+
-p, --password[=<privateKeyPassword>]
+
+

Private key password.

+
+
--pubout=<publicKeyPath>
+
+

Public key output file. This option is required when generating a new key pair (if given private key doesn’t exist), and may optionally be used for outputting the public key if an already existing private key is being used.

+
+
--signer=<signer>
+
+

Free-format text string describing who signed this action, for example a person, team or organization name. If not specified, signer will be taken from a property named 'signer' in the file specified with the --info option if available, otherwise the current user name will be used as the signer.

+
+
--with=<privateKeyPath>
+
+

PEM file containing private key used for signing.

+
+
-y, --confirm
+
+

Confirm overwriting existing output file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-action.html b/v2.10.1/manpage/fcli-fod-action.html new file mode 100644 index 000000000..298ef2947 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-action.html @@ -0,0 +1,122 @@ +--- +title: fcli-fod-action(1) +fcli_version: +--- + + + + + + + +fcli-fod-action(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod action [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions. If you require any assistance with developing custom actions, please consult with Fortify Professional Services.

+
+
+

Note that the ability to load and run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions, even between minor fcli releases. Based on user feedback, we will stabilize action syntax over the next couple of fcli releases, after which any breaking action syntax changes will be considered a major fcli version change.

+
+
+

This fcli version supports the following action schema versions: See fcli help output.

+
+
+

Actions can potentially perform dangerous operations like deleting data or posting data to 3rd-party systems, so it is recommended to only run trusted actions. Action authors can sign their actions using the action sign command; actions without a (valid) signature will require confirmation when trying to run them. Trusted public keys can be configured through the fcli config public-key commands, or passed directly using the --pubkey option on various action-related commands.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get
+
+

Get action contents.

+
+
help
+
+

Show action usage help.

+
+
import
+
+

Import custom actions.

+
+
list, ls
+
+

List built-in actions.

+
+
reset
+
+

Remove all custom actions.

+
+
run
+
+

Run an action.

+
+
sign
+
+

Sign action.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-create.html b/v2.10.1/manpage/fcli-fod-app-create.html new file mode 100644 index 000000000..72b0de4e5 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-create.html @@ -0,0 +1,206 @@ +--- +title: fcli-fod-app-create(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app create [--auto-required-attrs] --criticality=<criticalityType> + [-d=<description>] [--delim=<delimiter>] --owner=<owner> + --release=[ms:]rel + [--release-description=<releaseDescription>] + --status=<sdlcStatusType> --type=<appType> [,[ATTR=VALUE]…​]]…​ [--groups=<userGroups>_[, + <userGroups>…​]]…​ [--notify=<notifications>[, + <notifications>…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <applicationName>

+
+
+
+
+

Description

+
+
+

This command allows a new application and its first release to be created. Please note some attributes might be mandatory depending on the configuration of your tenant. Please check the Fortify on Demand web portal first.

+
+
+
+
+

Options

+
+
+
+
--attrs, --attributes=[ATTR=VALUE][,[ATTR=VALUE]…​]
+
+

Set of application and release attribute id’s or names and their values to set. Please note for user attributes only the userId is currently supported.

+
+
--auto-required-attrs
+
+

Automatically set a default value for required attributes. Please note for Picklist and User attributes this will set the value to the first item in the list, for Boolean attributes it will set the value to 'false' and for Text attributes it will fill with 'autofilled by fcli'.

+
+
--criticality, --business-criticality=<criticalityType>
+
+

The business criticality of the application. Valid values: High, Medium, Low.

+
+
-d, --description=<description>
+
+

Description of the application.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--groups=<userGroups>[,<userGroups>…​]
+
+

User group ids or names to give access of the application to.

+
+
--notify=<notifications>[,<notifications>…​]
+
+

Email address of user(s) to send notifications to.

+
+
--owner=<owner>
+
+

The owner of the application/release who will receive email notifications of scan status update.

+
+
--release=[ms:]rel
+
+

Initial release to be created on the application, in the format <microservice>:<release> for a microservices application, or just <release> for non-microservices applications.

+
+
--release-description=<releaseDescription>
+
+

Description of the release.

+
+
--status, --sdlc-status=<sdlcStatusType>
+
+

The SDLC lifecycle status of the release. Valid values: Development, QA, Production

+
+
--type, --app-type=<appType>
+
+

Application type. Valid values: Web, ThickClient, Mobile, Microservice

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<applicationName>
+
+

Application name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-delete.html b/v2.10.1/manpage/fcli-fod-app-delete.html new file mode 100644 index 000000000..b57b51324 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-delete.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-app-delete(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app delete [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <appNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-get.html b/v2.10.1/manpage/fcli-fod-app-get.html new file mode 100644 index 000000000..e9d1fc677 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-app-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <appNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-list-scans.html b/v2.10.1/manpage/fcli-fod-app-list-scans.html new file mode 100644 index 000000000..9a3f8d6d4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-list-scans.html @@ -0,0 +1,143 @@ +--- +title: fcli-fod-app-list-scans(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-list-scans(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app list-scans --app=<appNameOrId> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--app=<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-list.html b/v2.10.1/manpage/fcli-fod-app-list.html new file mode 100644 index 000000000..48b0f2ab8 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-list.html @@ -0,0 +1,144 @@ +--- +title: fcli-fod-app-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app list [--filters-param=<filtersParam>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app-update.html b/v2.10.1/manpage/fcli-fod-app-update.html new file mode 100644 index 000000000..3465dca94 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app-update.html @@ -0,0 +1,174 @@ +--- +title: fcli-fod-app-update(1) +fcli_version: +--- + + + + + + + +fcli-fod-app-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app update [--criticality=<criticalityType>] [-d=<descriptionUpdate>] + [-n=<applicationNameUpdate>] [, + _[ATTR=VALUE]…​]]…​ [--notify=<notificationsUpdate>[, + <notificationsUpdate>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <appNameOrId>

+
+
+
+
+

Description

+
+
+

This command updates the details of an application. To create, update or delete any releases on the application use the 'fcli fod release' subcommands. To create, update or delete any microservices on the application use the 'fcli fod microservice' subcommands. To update user and group access for the application use the 'fcli fod access-control' subcommands.

+
+
+
+
+

Options

+
+
+
+
--attrs, --attributes=[ATTR=VALUE][,[ATTR=VALUE]…​]
+
+

Set of application attribute id’s or names and their values to set. Please note for user attributes only the userId is currently supported. Release attributes may be provided but will be ignored.

+
+
--criticality, --business-criticality=<criticalityType>
+
+

The business criticality of the application. Valid values: High, Medium, Low.

+
+
-d, --description=<descriptionUpdate>
+
+

The updated description for the application.

+
+
-n, --name=<applicationNameUpdate>
+
+

The updated name for the application.

+
+
--notify=<notificationsUpdate>[,<notificationsUpdate>…​]
+
+

Email address of user(s) to send notifications to (Please note, any existing entries will be replaced).

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-app.html b/v2.10.1/manpage/fcli-fod-app.html new file mode 100644 index 000000000..9c404b9e4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-app.html @@ -0,0 +1,107 @@ +--- +title: fcli-fod-app(1) +fcli_version: +--- + + + + + + + +fcli-fod-app(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod app [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List applications.

+
+
get
+
+

Get application details.

+
+
create
+
+

Create a new application.

+
+
update
+
+

Update an existing application.

+
+
delete, rm
+
+

Delete an application.

+
+
list-scans, lss
+
+

List scans for a given application.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-cancel.html b/v2.10.1/manpage/fcli-fod-dast-scan-cancel.html new file mode 100644 index 000000000..79007fbd2 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-cancel.html @@ -0,0 +1,139 @@ +--- +title: fcli-fod-dast-scan-cancel(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-cancel(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan cancel [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-download-latest.html b/v2.10.1/manpage/fcli-fod-dast-scan-download-latest.html new file mode 100644 index 000000000..e15f3d59a --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-download-latest.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-dast-scan-download-latest(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-download-latest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan download-latest [--delim=<delimiter>] -f=<file> --rel=id|app + _ [:ms]:rel_ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-download.html b/v2.10.1/manpage/fcli-fod-dast-scan-download.html new file mode 100644 index 000000000..f67f5158c --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-download.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-dast-scan-download(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan download [--delim=<delimiter>] -f=<file> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-get-config.html b/v2.10.1/manpage/fcli-fod-dast-scan-get-config.html new file mode 100644 index 000000000..7d4a54c7b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-get-config.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-dast-scan-get-config(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-get-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan get-config [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for DAST Automated scanning. Please note: DAST Automated scanning is still in technical preview and therefore, command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-import.html b/v2.10.1/manpage/fcli-fod-dast-scan-import.html new file mode 100644 index 000000000..1ebbd6f5f --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-import.html @@ -0,0 +1,159 @@ +--- +title: fcli-fod-dast-scan-import(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan import [--chunk-size=<chunkSize>] [--delim=<delimiter>] + -f=<file> [--progress=<type>] --rel=id|app[:ms]:rel + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

As FoD doesn’t return a scan id for imported scans, the output of this command cannot be used with commands that expect a scan id, like the wait-for command.

+
+
+
+
+

Options

+
+
+
+
--chunk-size=<chunkSize>
+
+

Size of each chunk (in bytes) for file uploads. Default is 1048576.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

FPR file containing existing DAST scan results to be imported.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-list.html b/v2.10.1/manpage/fcli-fod-dast-scan-list.html new file mode 100644 index 000000000..bc70cb9ea --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-fod-dast-scan-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan list [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-setup-api.html b/v2.10.1/manpage/fcli-fod-dast-scan-setup-api.html new file mode 100644 index 000000000..bb95704dd --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-setup-api.html @@ -0,0 +1,234 @@ +--- +title: fcli-fod-dast-scan-setup-api(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-setup-api(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan setup-api [--false-positive-removal] + --assessment-type=<assessmentType> + [--delim=<delimiter>] + [--entitlement-id=<entitlementId>] + [--environment=<environmentFacingType>] + [-f=<file>] [--file-id=<fileId>] + --frequency=<entitlementFrequencyType> + [--host=<apiHost>] [--key=<apiKey>] + [--network-auth-type=<networkAuthenticationType>] + [-p=<password>] --rel=id|app[:ms]:rel + [--scheme-type=<apiSchemeType>] + [--service-path=<apiServicePath>] + [--timebox=<timebox>] [--timezone=<timezone>] + --type=<apiType> [-u=<username>] [--url=<apiUrl>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +To correctly setup a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. +If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement. +In order to use an OpenAPI specification, Postman collection, GraphQL schema file or GRPC proto file, you can upload it directly using the '--file' option, or you can refer to a previously uploaded File Id that was uploaded using the 'fod dast-scan upload-file' command.

+
+
+
+
+

Options

+
+
+
+
--assessment-type=<assessmentType>
+
+

The type of DAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' to display valid values.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--entitlement-id=<entitlementId>
+
+

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

+
+
--environment=<environmentFacingType>
+
+

The public facing visibility of the environment. Valid values: Internal, External.

+
+
-f, --file=<file>
+
+

An OpenAPI specification, Postman collection, GraphQL schema file or GRPC proto file.

+
+
--false-positive-removal
+
+

Request false positive removal by the testing team (once per application).

+
+
--file-id=<fileId>
+
+

The file Id of a Workflow Macro previously uploaded using the 'fod dast-scan upload-file' command.

+
+
--frequency, --entitlement-frequency=<entitlementFrequencyType>
+
+

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

+
+
--host=<apiHost>
+
+

API Host.

+
+
--key, --api-key=<apiKey>
+
+

API Key to use for authentication.

+
+
--network-auth-type=<networkAuthenticationType>
+
+

The Network Authentication type to use. Valid values: Basic, NTLM, Kerberos, Digest, Automatic, ADFS_CBT.

+
+
-p, --network-password=<password>
+
+

The Network Password to use.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--scheme-type=<apiSchemeType>
+
+

API Scheme Type. Valid values: HTTP, HTTPS, HTTPandHTTPs.

+
+
--service-path=<apiServicePath>
+
+

API Service Path.

+
+
--timebox=<timebox>
+
+

Timebox for the scan duration (in hours).

+
+
--timezone=<timezone>
+
+

The timezone in which the website is running in.

+
+
--type=<apiType>
+
+

The type of API to scan. Valid Values: OpenApi, Postman, GraphQL, GRPC

+
+
-u, --network-username=<username>
+
+

The Network Username to use.

+
+
--url, --api-url=<apiUrl>
+
+

The URL to the API definition file.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-setup-website.html b/v2.10.1/manpage/fcli-fod-dast-scan-setup-website.html new file mode 100644 index 000000000..2054c7afa --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-setup-website.html @@ -0,0 +1,260 @@ +--- +title: fcli-fod-dast-scan-setup-website(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-setup-website(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan setup-website [--create-login-macro] + [--false-positive-removal] + [--redundant-page-detection] [--restrict] + --assessment-type=<assessmentType> + [--delim=<delimiter>] + [--entitlement-id=<entitlementId>] + [--environment=<environmentFacingType>] + [-f=<file>] [--file-id=<loginMacroFileId>] + --frequency=<entitlementFrequencyType> + [--macro-primary-password=<macroPrimaryPassword + _ >_] + [--macro-primary-username=<macroPrimaryUsername + _ >_] + [--macro-secondary-password=<macroSecondaryPass + _ word>_] + [--macro-secondary-username=<macroSecondaryUser + _ name>_] + [--network-auth-type=<networkAuthenticationType + _ >_] [-p=<password>] [--policy=<scanPolicy>] + --rel=id|app[:ms]:rel [--timebox=<timebox>] + [--timezone=<timezone>] [-u=<username>] + --url=<siteUrl> [-e=<exclusions>[, + <exclusions>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +To correctly setup a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. +If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement. +If you wish to use a Login Macro for authentication then you can upload it directly using the '--file' option, or you can refer to a previously uploaded File Id that was uploaded using the 'fod dast-scan upload-file' command.

+
+
+
+
+

Options

+
+
+
+
--assessment-type=<assessmentType>
+
+

The type of DAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' to display valid values.

+
+
--create-login-macro
+
+

Request generation of a login macro by the testing team (once per application).

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-e, --exclusions=<exclusions>[,<exclusions>…​]
+
+

A comma separated list of URLs to exclude from being scanned.

+
+
--entitlement-id=<entitlementId>
+
+

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

+
+
--environment=<environmentFacingType>
+
+

The public facing visibility of the environment. Valid values: Internal, External.

+
+
-f, --file=<file>
+
+

A Login Macro file to upload and use for authentication in the website scan.

+
+
--false-positive-removal
+
+

Request false positive removal by the testing team (once per application).

+
+
--file-id=<loginMacroFileId>
+
+

The file Id of a Login Macro previously uploaded using the 'fod dast-scan upload-file' command.

+
+
--frequency, --entitlement-frequency=<entitlementFrequencyType>
+
+

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

+
+
--macro-primary-password=<macroPrimaryPassword>
+
+

Login macro password for the primary user.

+
+
--macro-primary-username=<macroPrimaryUsername>
+
+

Login macro username for the primary user.

+
+
--macro-secondary-password=<macroSecondaryPassword>
+
+

Login macro password for the secondary user.

+
+
--macro-secondary-username=<macroSecondaryUsername>
+
+

Login macro username for the secondary user.

+
+
--network-auth-type=<networkAuthenticationType>
+
+

The Network Authentication type to use. Valid values: Basic, NTLM, Kerberos, Digest, Automatic, ADFS_CBT.

+
+
-p, --network-password=<password>
+
+

The Network Password to use.

+
+
--policy=<scanPolicy>
+
+

The Scan Policy to use. Use 'fod rest lookup DastAutomatedScanPolicies' to display valid values.

+
+
--redundant-page-detection
+
+

Enable redundant page detection.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--restrict
+
+

Restrict the scan to the URL directory and subdirectories. If not selected then the entire host will be scanned.

+
+
--timebox=<timebox>
+
+

Timebox for the scan duration (in hours).

+
+
--timezone=<timezone>
+
+

The timezone in which the website is running in.

+
+
-u, --network-username=<username>
+
+

The Network Username to use.

+
+
--url, --site-url=<siteUrl>
+
+

Base URL for accessing the remote system.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-setup-workflow.html b/v2.10.1/manpage/fcli-fod-dast-scan-setup-workflow.html new file mode 100644 index 000000000..44fad7262 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-setup-workflow.html @@ -0,0 +1,213 @@ +--- +title: fcli-fod-dast-scan-setup-workflow(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-setup-workflow(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan setup-workflow [--false-positive-removal] + --assessment-type=<assessmentType> + [--delim=<delimiter>] + [--entitlement-id=<entitlementId>] + [--environment=<environmentFacingType>] + [-f=<file>] [--file-id=<workflowMacroFileId>] + --frequency=<entitlementFrequencyType> + [--network-auth-type=<networkAuthenticationTyp + _ e>_] [-p=<password>] [--policy=<scanPolicy>] + --rel=id|app[:ms]:rel [--timezone=<timezone>] + [-u=<username>] [--hosts=<allowedHosts>[, + <allowedHosts>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +To correctly setup a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. +If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement. +In order to use a Workflow Macro you can upload it directly using the '--file' option, or you can refer to a previously uploaded File Id that was uploaded using the 'fod dast-scan upload-file' command.

+
+
+
+
+

Options

+
+
+
+
--assessment-type=<assessmentType>
+
+

The type of DAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' to display valid values.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--entitlement-id=<entitlementId>
+
+

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

+
+
--environment=<environmentFacingType>
+
+

The public facing visibility of the environment. Valid values: Internal, External.

+
+
-f, --file=<file>
+
+

A Workflow file to upload and use for authentication in the website scan.

+
+
--false-positive-removal
+
+

Request false positive removal by the testing team (once per application).

+
+
--file-id=<workflowMacroFileId>
+
+

The Id of a file previously uploaded using the 'fod dast-scan upload-file' command.

+
+
--frequency, --entitlement-frequency=<entitlementFrequencyType>
+
+

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

+
+
--hosts, --allowed-hosts=<allowedHosts>[,<allowedHosts>…​]
+
+

The FQDN and port of any hosts that that you want to be scanned, e.g. "test.mysite.com:443".

+
+
--network-auth-type=<networkAuthenticationType>
+
+

The Network Authentication type to use. Valid values: Basic, NTLM, Kerberos, Digest, Automatic, ADFS_CBT.

+
+
-p, --network-password=<password>
+
+

The Network Password to use.

+
+
--policy=<scanPolicy>
+
+

The Scan Policy to use. Use 'fod rest lookup DastAutomatedScanPolicies' to display valid values.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--timezone=<timezone>
+
+

The timezone in which the website is running in.

+
+
-u, --network-username=<username>
+
+

The Network Username to use.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-start.html b/v2.10.1/manpage/fcli-fod-dast-scan-start.html new file mode 100644 index 000000000..344dcc18b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-start.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-dast-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan start [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for DAST Automated scanning. Please note: DAST Automated scanning is still in technical preview and therefore, command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +The scan will need to have been previously setup using the FoD UI or one of the 'fod dast-scan setup-xxx' commands.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan-upload-file.html b/v2.10.1/manpage/fcli-fod-dast-scan-upload-file.html new file mode 100644 index 000000000..d8ed07850 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan-upload-file.html @@ -0,0 +1,153 @@ +--- +title: fcli-fod-dast-scan-upload-file(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan-upload-file(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan upload-file [--delim=<delimiter>] -f=<file> + --file-type=<dastFileType> --rel=id|app[:ms]:rel + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name of file to upload.

+
+
--file-type, --dast-file-type=<dastFileType>
+
+

The type of DAST Automated file to upload. Valid values: OpenAPIDefinition, PostmanCollection, GraphQLDefinition, GRPCDefinition, WorkflowDrivenMacro, LoginMacro.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-dast-scan.html b/v2.10.1/manpage/fcli-fod-dast-scan.html new file mode 100644 index 000000000..008101f0e --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-dast-scan.html @@ -0,0 +1,127 @@ +--- +title: fcli-fod-dast-scan(1) +fcli_version: +--- + + + + + + + +fcli-fod-dast-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod dast-scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
cancel
+
+

(PREVIEW) Cancel a DAST scan.

+
+
download
+
+

Download scan results.

+
+
download-latest
+
+

Download latest scan results from release.

+
+
import
+
+

Import existing DAST scan results (from an FPR file).

+
+
list, ls
+
+

List DAST scans.

+
+
setup-website
+
+

(PREVIEW) Configure DAST Automated Website scan for the release.

+
+
setup-workflow
+
+

(PREVIEW) Configure DAST Automated Workflow scan for the release.

+
+
setup-api
+
+

(PREVIEW) Configure DAST Automated API scan for the release.

+
+
get-config
+
+

(PREVIEW) Get current DAST Automated scan configuration.

+
+
start
+
+

(PREVIEW) Start a new DAST Automated scan.

+
+
upload-file
+
+

(PREVIEW) Uploads a file for use with DAST Automated scans.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-issue-list.html b/v2.10.1/manpage/fcli-fod-issue-list.html new file mode 100644 index 000000000..aab63a6bf --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-issue-list.html @@ -0,0 +1,170 @@ +--- +title: fcli-fod-issue-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-issue-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod issue list [--delim=<delimiter>] [--filters-param=<filtersParam>] + --rel=id|app[:ms]:rel [--embed=<embedSuppliers>[, + <embedSuppliers>…​]]…​ [-i=<status>[,<status>…​]]…​ + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

This command allows for listing FoD vulnerability data for a given release. By default, only visible issues will be returned; the --include option can be used to (also) include suppressed or fixed issues. If any such issues are included, the default table output will show (S) and/or (F) for respectively suppressed and fixed issues.

+
+
+

Optionally, additional details may be included in the output using the --embed option, but please note that this may have a significant impact on performance as this will result in additional HTTP requests to FoD for every individual issue, and FoD rate limits may apply to those requests.

+
+
+

In general, performance of this command is largely dependent on the number of issues being retrieved from FoD. The default table output collects all data in memory until all issues have been processed, so it may take a long time before you see any output, and there’s a small risk of running out of memory. Most other output formats (like json, yaml, or csv) output data immediately after each page of issues has been loaded from FoD, resulting in more immediate output.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--embed=<embedSuppliers>[,<embedSuppliers>…​]
+
+

Embed extra issue data. Due to FoD rate limits, this may significantly affect performance. Allowed values: allData, summary, details, recommendations, history, requestResponse, headers, parameters, traces. Using the --output option, this extra data can be included in the output. Using the --query option, this extra data can be queried upon. To get an understanding of the structure and contents of the embedded data, use the --output json or --output yaml options.

+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-i, --include=<status>[,<status>…​]
+
+

By default, only visible issues will be returned. This option accepts a comma-separated list to allow (also) fixed and/or suppressed issues to be returned, for example --include visible,fixed (to return both visible and fixed issues) or --include fixed (to return only fixed issues). Allowed values: visible, fixed, suppressed.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-issue.html b/v2.10.1/manpage/fcli-fod-issue.html new file mode 100644 index 000000000..fe7702326 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-issue.html @@ -0,0 +1,87 @@ +--- +title: fcli-fod-issue(1) +fcli_version: +--- + + + + + + + +fcli-fod-issue(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod issue [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List vulnerabilities.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-cancel.html b/v2.10.1/manpage/fcli-fod-mast-scan-cancel.html new file mode 100644 index 000000000..0209f3132 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-cancel.html @@ -0,0 +1,139 @@ +--- +title: fcli-fod-mast-scan-cancel(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-cancel(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan cancel [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-download-latest.html b/v2.10.1/manpage/fcli-fod-mast-scan-download-latest.html new file mode 100644 index 000000000..e1f386b08 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-download-latest.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-mast-scan-download-latest(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-download-latest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan download-latest [--delim=<delimiter>] -f=<file> --rel=id|app + _ [:ms]:rel_ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-download.html b/v2.10.1/manpage/fcli-fod-mast-scan-download.html new file mode 100644 index 000000000..21722c44e --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-download.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-mast-scan-download(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan download [--delim=<delimiter>] -f=<file> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-get-config.html b/v2.10.1/manpage/fcli-fod-mast-scan-get-config.html new file mode 100644 index 000000000..28b296978 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-get-config.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-mast-scan-get-config(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-get-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan get-config [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. Please note: there is currently no API endpoint for this command and so it will fail with HTTP 405 error until this endpoint is available.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-get.html b/v2.10.1/manpage/fcli-fod-mast-scan-get.html new file mode 100644 index 000000000..c0f3ba16a --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-mast-scan-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-import.html b/v2.10.1/manpage/fcli-fod-mast-scan-import.html new file mode 100644 index 000000000..f15c97efd --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-import.html @@ -0,0 +1,159 @@ +--- +title: fcli-fod-mast-scan-import(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan import [--chunk-size=<chunkSize>] [--delim=<delimiter>] + -f=<file> [--progress=<type>] --rel=id|app[:ms]:rel + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

As FoD doesn’t return a scan id for imported scans, the output of this command cannot be used with commands that expect a scan id, like the wait-for command.

+
+
+
+
+

Options

+
+
+
+
--chunk-size=<chunkSize>
+
+

Size of each chunk (in bytes) for file uploads. Default is 1048576.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

FPR file containing existing MAST scan results to be imported.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-list.html b/v2.10.1/manpage/fcli-fod-mast-scan-list.html new file mode 100644 index 000000000..5c23ee3c4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-fod-mast-scan-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan list [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-start.html b/v2.10.1/manpage/fcli-fod-mast-scan-start.html new file mode 100644 index 000000000..fe9f9f760 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-start.html @@ -0,0 +1,202 @@ +--- +title: fcli-fod-mast-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan start --assessment-type=<mobileAssessmentType> + [--delim=<delimiter>] + [--entitlement-id=<entitlementId>] -f=<file> + --framework=<mobileFramework> + --frequency=<entitlementFrequencyType> + [--notes=<notes>] --platform=<mobilePlatform> + [--progress=<type>] --rel=id|app[:ms]:rel + [--remediation=<remediationScanPreferenceType>] + [--start-date=<startDate>] [--timezone=<timezone>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command is not fully implemented and is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +The scan will need to have been previously setup using the FoD UI or the 'fod mast-scan setup' command. +To correctly start a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. +The scan will need to have been previously setup using the FoD UI or the 'fod dast-scan setup' command. +If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement.

+
+
+
+
+

Options

+
+
+
+
--assessment-type=<mobileAssessmentType>
+
+

The type of MAST assessment to carry out. Use 'fod rest lookup AssessmentTypes' to find valid values.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--entitlement-id=<entitlementId>
+
+

The Id of the entitlement to use for the scan.

+
+
-f, --file=<file>
+
+

Absolute path of the mobile application file to upload, for example .apk or .ipa file. See FoD documentation for supported file types and packaging instructions.

+
+
--framework=<mobileFramework>
+
+

The Mobile Framework to use. Valid values: iOS, Android.

+
+
--frequency, --entitlement-frequency=<entitlementFrequencyType>
+
+

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

+
+
--notes=<notes>
+
+

Scan notes.

+
+
--platform=<mobilePlatform>
+
+

The Mobile Platform to use. Valid values: Phone, Tablet, Both.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--remediation, --remediation-preference=<remediationScanPreferenceType>
+
+

The remediation preference to use. Valid values: RemediationScanIfAvailable, RemediationScanOnly, NonRemediationScanOnly.

+
+
--start-date=<startDate>
+
+

Date to start the scan (in MM/dd/yyyy HH:mm format).

+
+
--timezone=<timezone>
+
+

The timezone to use for starting the scan - default is UTC. Use 'fod rest lookup TimeZones' to see the values.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan-wait-for.html b/v2.10.1/manpage/fcli-fod-mast-scan-wait-for.html new file mode 100644 index 000000000..437fce91e --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan-wait-for.html @@ -0,0 +1,216 @@ +--- +title: fcli-fod-mast-scan-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan wait-for [--delim=<delimiter>] [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequest + _ ed>_] [--progress=<type>] [-t=<timeoutPeriod>] + [-s=<states>[,<states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + scan-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a scan id (possibly stored using --store on one of the 'scan start-*' commands) to wait for scan completion. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following states are currently known by fcli: +See fcli help output

+
+
+

Please note it is recommended to pass the scan id’s as '<release-id>:<scan-id>' rather than just '<scan-id>'. If only '<scan-id>' is passed then its status might not be available yet, causing FoD to return a '404 - Not Found' error. It is recommended to pass a fcli variable to do this as it will automatically resolve to using <release-id>:<scan-id>. For example, to start a SAST scan and wait for it to complete, use:

+
+
+
+
fcli fod sast-scan start ... --store scan
+fcli fod sast-scan wait-for ::scan::
+
+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more scan states against which to match the given scans.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all scans match. If neither --until or --while are specified, default is to wait until all scans match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all scans match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id’s…​
+
+

Whitespace separated list of <release-id>:<scan-id> or <scan-id> items.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-mast-scan.html b/v2.10.1/manpage/fcli-fod-mast-scan.html new file mode 100644 index 000000000..f087cb9d9 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-mast-scan.html @@ -0,0 +1,119 @@ +--- +title: fcli-fod-mast-scan(1) +fcli_version: +--- + + + + + + + +fcli-fod-mast-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod mast-scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
cancel
+
+

Cancel a MAST scan.

+
+
download
+
+

Download scan results.

+
+
download-latest
+
+

Download latest scan results from release.

+
+
get
+
+

Get MAST scan details.

+
+
get-config
+
+

(PREVIEW) Get current MAST scan configuration.

+
+
import
+
+

Import existing MAST scan results (from an FPR file).

+
+
list, ls
+
+

List MAST scans.

+
+
start
+
+

(PREVIEW) Start a new MAST scan.

+
+
wait-for
+
+

Wait for one or more MAST scans to reach or exit specified scan statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-microservice-create.html b/v2.10.1/manpage/fcli-fod-microservice-create.html new file mode 100644 index 000000000..76670608a --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-microservice-create.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-microservice-create(1) +fcli_version: +--- + + + + + + + +fcli-fod-microservice-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod microservice create [--skip-if-exists] [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] app:ms

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--skip-if-exists
+
+

Check to see if microservice already exists before creating.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
app:ms
+
+

Microservice name in the format <application>:<microservice>.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-microservice-delete.html b/v2.10.1/manpage/fcli-fod-microservice-delete.html new file mode 100644 index 000000000..de2fe304b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-microservice-delete.html @@ -0,0 +1,154 @@ +--- +title: fcli-fod-microservice-delete(1) +fcli_version: +--- + + + + + + + +fcli-fod-microservice-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod microservice delete [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] app:ms

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
app:ms
+
+

Microservice name in the format <application>:<microservice>.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-microservice-list.html b/v2.10.1/manpage/fcli-fod-microservice-list.html new file mode 100644 index 000000000..0c7b15157 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-microservice-list.html @@ -0,0 +1,143 @@ +--- +title: fcli-fod-microservice-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-microservice-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod microservice list --app=<appNameOrId> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--app=<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-microservice-update.html b/v2.10.1/manpage/fcli-fod-microservice-update.html new file mode 100644 index 000000000..bc475d716 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-microservice-update.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-microservice-update(1) +fcli_version: +--- + + + + + + + +fcli-fod-microservice-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod microservice update [--delim=<delimiter>] -n=<microserviceName> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] app:ms

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-n, --name=<microserviceName>
+
+

The updated name for the microservice.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
app:ms
+
+

Microservice name in the format <application>:<microservice>.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-microservice.html b/v2.10.1/manpage/fcli-fod-microservice.html new file mode 100644 index 000000000..3ab58fbd4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-microservice.html @@ -0,0 +1,99 @@ +--- +title: fcli-fod-microservice(1) +fcli_version: +--- + + + + + + + +fcli-fod-microservice(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod microservice [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List application microservices.

+
+
create
+
+

Create a new application microservice.

+
+
update
+
+

Update an existing application microservice.

+
+
delete, rm
+
+

Delete an application microservice.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-download-latest.html b/v2.10.1/manpage/fcli-fod-oss-scan-download-latest.html new file mode 100644 index 000000000..1490b4b83 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-download-latest.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-oss-scan-download-latest(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-download-latest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan download-latest [--delim=<delimiter>] -f=<file> --rel=id|app[: + _ ms]:rel_ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the SBOM file.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-download.html b/v2.10.1/manpage/fcli-fod-oss-scan-download.html new file mode 100644 index 000000000..74d5f7c49 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-download.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-oss-scan-download(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan download [--delim=<delimiter>] -f=<file> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the SBOM file.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-get.html b/v2.10.1/manpage/fcli-fod-oss-scan-get.html new file mode 100644 index 000000000..652679bd9 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-oss-scan-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-import-debricked.html b/v2.10.1/manpage/fcli-fod-oss-scan-import-debricked.html new file mode 100644 index 000000000..02697a4ab --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-import-debricked.html @@ -0,0 +1,200 @@ +--- +title: fcli-fod-oss-scan-import-debricked(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-import-debricked(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan import-debricked -b=<branch> [--chunk-size=<chunkSize>] + [--delim=<delimiter>] -f=<file> + [--progress=<type>] -r=<repository> + --rel=id|app[:ms]:rel [--type=<type>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + ([-k] [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>]) + ((-u=<user> -p[=<password>]) | -t + [=<accessToken>])

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-b, --branch=<branch>
+
+

Branch in the given repository for which to retrieve the SBOM.

+
+
--chunk-size=<chunkSize>
+
+

Size of each chunk (in bytes) for file uploads. Default is 1048576.

+
+
--connect-timeout=<connectTimeout>
+
+

Debricked connection timeout, for example 30s (30 seconds), 5m (5 minutes). Default value: null.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

Save a copy of the SBOM file downloaded from Debricked to the given file.

+
+
-k, --insecure
+
+

Disable SSL checks when connecting to Debricked.

+
+
-p, --debricked-password[=<password>]
+
+

Password for the given debricked user.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-r, --repository=<repository>
+
+

Debricked repository name or id.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--socket-timeout=<socketTimeout>
+
+

Debricked socket timeout, for example 30s (30 seconds), 5m (5 minutes). Default value: null.

+
+
-t, --debricked-access-token[=<accessToken>]
+
+

Debricked long-lived access token.

+
+
--type=<type>
+
+

Open Source scan results file type. Valid values: CycloneDX (default value is CycloneDX).

+
+
-u, --debricked-user=<user>
+
+

Debricked user name / email address.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-import.html b/v2.10.1/manpage/fcli-fod-oss-scan-import.html new file mode 100644 index 000000000..07731d6d3 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-import.html @@ -0,0 +1,163 @@ +--- +title: fcli-fod-oss-scan-import(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan import [--chunk-size=<chunkSize>] [--delim=<delimiter>] + -f=<file> [--progress=<type>] --rel=id|app[:ms]:rel + [--type=<type>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

As FoD doesn’t return a scan id for imported scans, the output of this command cannot be used with commands that expect a scan id, like the wait-for command.

+
+
+
+
+

Options

+
+
+
+
--chunk-size=<chunkSize>
+
+

Size of each chunk (in bytes) for file uploads. Default is 1048576.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

FPR file containing existing OSS scan results to be imported.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--type=<type>
+
+

Open Source scan results file type. Valid values: CycloneDX (default value is CycloneDX).

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-list.html b/v2.10.1/manpage/fcli-fod-oss-scan-list.html new file mode 100644 index 000000000..ecf00f1a7 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-fod-oss-scan-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan list [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-start.html b/v2.10.1/manpage/fcli-fod-oss-scan-start.html new file mode 100644 index 000000000..ced474759 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-start.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-oss-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan start [--delim=<delimiter>] -f=<file> --rel=id|app[:ms]:rel + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is not fully implemented and is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

Absolute path of the ScanCentral package (.Zip) file to upload.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan-wait-for.html b/v2.10.1/manpage/fcli-fod-oss-scan-wait-for.html new file mode 100644 index 000000000..62b93922f --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan-wait-for.html @@ -0,0 +1,216 @@ +--- +title: fcli-fod-oss-scan-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan wait-for [--delim=<delimiter>] [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequeste + _ d>_] [--progress=<type>] [-t=<timeoutPeriod>] + [-s=<states>[,<states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + scan-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a scan id (possibly stored using --store on one of the 'scan start-*' commands) to wait for scan completion. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following states are currently known by fcli: +See fcli help output

+
+
+

Please note it is recommended to pass the scan id’s as '<release-id>:<scan-id>' rather than just '<scan-id>'. If only '<scan-id>' is passed then its status might not be available yet, causing FoD to return a '404 - Not Found' error. It is recommended to pass a fcli variable to do this as it will automatically resolve to using <release-id>:<scan-id>. For example, to start a SAST scan and wait for it to complete, use:

+
+
+
+
fcli fod sast-scan start ... --store scan
+fcli fod sast-scan wait-for ::scan::
+
+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more scan states against which to match the given scans.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all scans match. If neither --until or --while are specified, default is to wait until all scans match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all scans match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id’s…​
+
+

Whitespace separated list of <release-id>:<scan-id> or <scan-id> items.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-oss-scan.html b/v2.10.1/manpage/fcli-fod-oss-scan.html new file mode 100644 index 000000000..8cbd53d73 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-oss-scan.html @@ -0,0 +1,115 @@ +--- +title: fcli-fod-oss-scan(1) +fcli_version: +--- + + + + + + + +fcli-fod-oss-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod oss-scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
download
+
+

Download scan results.

+
+
download-latest
+
+

Download latest scan results from release.

+
+
get
+
+

Get OSS scan details.

+
+
import
+
+

Import existing OSS scan results (from an SBOM file).

+
+
import-debricked
+
+

Import results from Debricked.

+
+
list, ls
+
+

List OSS scans.

+
+
start
+
+

(PREVIEW) Start a new OSS scan.

+
+
wait-for
+
+

Wait for one or more OSS scans to reach or exit specified scan statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-create.html b/v2.10.1/manpage/fcli-fod-release-create.html new file mode 100644 index 000000000..982ab0aaf --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-create.html @@ -0,0 +1,220 @@ +--- +title: fcli-fod-release-create(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release create [--auto-required-attrs] [--skip-if-exists] + [--copy-from=id|app[:ms]:rel] [-d=<description>] + [--delim=<delimiter>] --status=<sdlcStatusType> + [,[ATTR=VALUE]…​]]…​ [[-h] + [--env-prefix=<envPrefix>_] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [[--app-description=<appDescription>] + [--app-notify=<appNotifications>[, + <appNotifications>…​]]…​ [--app-owner=<appOwner>] + [--app-groups=<appUserGroups>[,<appUserGroups>…​]]…​ + [--app-type=<appType>] + [--app-criticality=<criticalityType>]] app[:ms]:rel

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--attrs, --attributes=[ATTR=VALUE][,[ATTR=VALUE]…​]
+
+

Set of application & release attribute id’s or names and corresponding values. Please note for user attributes only the userId is currently supported. Depending on FoD configuration, some attributes may be required and either need to be set explicitly or auto-filled through the --auto-required-attrs option. Application attributes will be applied when creating a new application and ignored if the application already exists. Similarly, release attributes will be ignored if the release already exists and --skip-if-exists is enabled.

+
+
--auto-required-attrs
+
+

Automatically set a default value for required application and release attributes.

+
+
--copy-from=id|app[:ms]:rel
+
+

The id or name of a release to copy existing state from. Note that FoD will put the release in 'suspended' state until copying is complete, during which time scan requests and other operations may be rejected. If you want to run any other operations on the release, it is recommended to first invoke the fcli fod release wait-for command to wait until the release leaves suspended state. This option is ignored if the release name to be copied is equal to the release name to be created, or when creating the first release on a (new) application.

+
+
-d, --description=<description>
+
+

Description of the release.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--skip-if-exists
+
+

Check to see if release already exists before creating.

+
+
--status, --sdlc-status=<sdlcStatusType>
+
+

The SDLC lifecycle status of the release. Valid values: Development, QA, Production

+
+
+
+
+
+
+

Application creation options (ignored if application exists)

+
+
+
+
--app-criticality=<criticalityType>
+
+

Required application business criticality when creating a new application. Valid values: High, Medium, Low.

+
+
--app-description=<appDescription>
+
+

Optional application description when creating a new application.

+
+
--app-groups=<appUserGroups>[,<appUserGroups>…​]
+
+

Optional user group ids or names to give access to the application when creating a new application.

+
+
--app-notify=<appNotifications>[,<appNotifications>…​]
+
+

Optional email address(es) when creating a new application to specify application user(s) to send notifications to.

+
+
--app-owner=<appOwner>
+
+

Required application owner when creating a new application.

+
+
--app-type=<appType>
+
+

Required application type when creating a new application. Valid values: Web, ThickClient, Mobile, Microservice.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
app[:ms]:rel
+
+

Release name in the format <application>[:<microservice>]:<release>.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-delete.html b/v2.10.1/manpage/fcli-fod-release-delete.html new file mode 100644 index 000000000..0394245b1 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-delete.html @@ -0,0 +1,153 @@ +--- +title: fcli-fod-release-delete(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release delete [--delim=<delimiter>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] id|app[:ms]:rel

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-get.html b/v2.10.1/manpage/fcli-fod-release-get.html new file mode 100644 index 000000000..9efc93018 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-get.html @@ -0,0 +1,153 @@ +--- +title: fcli-fod-release-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release get [--delim=<delimiter>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] id|app[:ms]:rel

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-list-assessment-types.html b/v2.10.1/manpage/fcli-fod-release-list-assessment-types.html new file mode 100644 index 000000000..cc36b370b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-list-assessment-types.html @@ -0,0 +1,157 @@ +--- +title: fcli-fod-release-list-assessment-types(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-list-assessment-types(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release list-assessment-types [--delim=<delimiter>] --rel=id|app[:ms]: + _ rel_ [--scan-types=<scanTypes>[, + <scanTypes>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--scan-types=<scanTypes>[,<scanTypes>…​]
+
+

Comma-separated list of scan types for which to list assessment types. Default value: Static,Dynamic,Mobile. Valid values: Static, Dynamic, Mobile, Monitoring, Network, OpenSource, Container.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-list-scans.html b/v2.10.1/manpage/fcli-fod-release-list-scans.html new file mode 100644 index 000000000..3594a5f52 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-list-scans.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-release-list-scans(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-list-scans(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release list-scans [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-list.html b/v2.10.1/manpage/fcli-fod-release-list.html new file mode 100644 index 000000000..462da4e51 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-fod-release-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release list [--app=<appNameOrId>] [--filters-param=<filtersParam>] + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--app=<appNameOrId>
+
+

Application id or name. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-update.html b/v2.10.1/manpage/fcli-fod-release-update.html new file mode 100644 index 000000000..f03cff8cd --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-update.html @@ -0,0 +1,176 @@ +--- +title: fcli-fod-release-update(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release update [-d=<description>] [--delim=<delimiter>] + [-n=<releaseName>] [--owner=<releaseOwner>] + [--status=<sdlcStatusType>] [, + _[ATTR=VALUE]…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] id|app[:ms]:rel

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--attrs, --attributes=[ATTR=VALUE][,[ATTR=VALUE]…​]
+
+

Set of release attribute id’s or names and their values to set on the release. Please note for user attributes only the userId is currently supported. Application attributes may be provided but will be ignored.

+
+
-d, --description=<description>
+
+

Updated description for the release.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-n, --name=<releaseName>
+
+

The updated name for the release.

+
+
--owner=<releaseOwner>
+
+

Updated id or username for the owner of the release.

+
+
--status, --sdlc-status=<sdlcStatusType>
+
+

The SDLC lifecycle status of the release. Valid values: Development, QA, Production

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release-wait-for.html b/v2.10.1/manpage/fcli-fod-release-wait-for.html new file mode 100644 index 000000000..20be01b04 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release-wait-for.html @@ -0,0 +1,208 @@ +--- +title: fcli-fod-release-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-fod-release-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release wait-for [--delim=<delimiter>] [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequested + _ >_] [--progress=<type>] [-s=true|false] + [-t=<timeoutPeriod>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-u=any-match|all-match | -w=any-match|all-match] + [[--session=<sessionName>]] id|app[:ms]:rel…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass one or more release names or id’s to wait until those releases leave 'suspended' state.

+
+
+

Most common use case is to invoke this wait-for command after creating a new release through the fcli fod release create command with the --copy-from option; FoD will put the newly created release in 'suspended' state until copying is completed, during which time scan requests and other operations may be rejected.

+
+
+

Note that contrary to other fcli wait-for commands, any options related to unknown or failure state handling are not applicable to this wait-for command and will be ignored.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --suspended=true|false
+
+

Suspended state against which to match the given releases; may be false (default) or true.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all releases match. If neither --until or --while are specified, default is to wait until all releases match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all releases match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
id|app[:ms]:rel…​
+
+

One or more release id’s or <application>[:<microservice>]:<release> names.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-release.html b/v2.10.1/manpage/fcli-fod-release.html new file mode 100644 index 000000000..ce61d08f1 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-release.html @@ -0,0 +1,115 @@ +--- +title: fcli-fod-release(1) +fcli_version: +--- + + + + + + + +fcli-fod-release(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod release [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List application releases.

+
+
get
+
+

Get application release details.

+
+
create
+
+

Create a new application release.

+
+
update
+
+

Update an existing application release.

+
+
delete, rm
+
+

Delete an application release.

+
+
list-assessment-types, lsat
+
+

List assessment types for a given release.

+
+
list-scans, lss
+
+

List scans for a given release.

+
+
wait-for
+
+

Wait for one or more scans to reach or exit suspended state.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-create.html b/v2.10.1/manpage/fcli-fod-report-create.html new file mode 100644 index 000000000..5e67dbe53 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-create.html @@ -0,0 +1,173 @@ +--- +title: fcli-fod-report-create(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report create [--delim=<delimiter>] --format=<format> + [--notes=<notes>] --rel=id|app[:ms]:rel + --template=id|name [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <reportName>

+
+
+
+
+

Description

+
+
+

This command allows a new report to be created for a release. To find the name or id of a report template to use, please use the "fod report list-templates" command.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--format=<format>
+
+

The format of the report to create. Valid values: pdf, html.

+
+
--notes=<notes>
+
+

Any additional notes to add to the report.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--template=id|name
+
+

Report template name or id.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportName>
+
+

The name of the report to create - this needs to be unique for the release.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-delete.html b/v2.10.1/manpage/fcli-fod-report-delete.html new file mode 100644 index 000000000..7b0ed9439 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-delete.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-report-delete(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report delete [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] report-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
report-id
+
+

Report id(s).

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-download.html b/v2.10.1/manpage/fcli-fod-report-download.html new file mode 100644 index 000000000..ef1170375 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-download.html @@ -0,0 +1,155 @@ +--- +title: fcli-fod-report-download(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report download -f=<file> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] report-id

+
+
+
+
+

Description

+
+
+

Note: reports generated in PDF format should be downloaded with a .pdf extension, reports generated in HTML format however should be downloaded as files with a .zip extension. The HTML file will be inside the Zip file.

+
+
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

File path and name where to save the report.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
report-id
+
+

Report id(s).

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-get.html b/v2.10.1/manpage/fcli-fod-report-get.html new file mode 100644 index 000000000..4656a0d08 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-report-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] report-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
report-id
+
+

Report id(s).

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-list-templates.html b/v2.10.1/manpage/fcli-fod-report-list-templates.html new file mode 100644 index 000000000..f9ba1fdb6 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-list-templates.html @@ -0,0 +1,145 @@ +--- +title: fcli-fod-report-list-templates(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-list-templates(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report list-templates [--group=<groupType>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--group=<groupType>
+
+

Report template group. Default value is All. Valid values: All, Standard, Custom.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-list.html b/v2.10.1/manpage/fcli-fod-report-list.html new file mode 100644 index 000000000..374c860f3 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-list.html @@ -0,0 +1,144 @@ +--- +title: fcli-fod-report-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report list [--filters-param=<filtersParam>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--filters-param=<filtersParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See the Fortify on Demand REST API documentation for information on supported formats.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report-wait-for.html b/v2.10.1/manpage/fcli-fod-report-wait-for.html new file mode 100644 index 000000000..9201387d0 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report-wait-for.html @@ -0,0 +1,202 @@ +--- +title: fcli-fod-report-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-fod-report-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report wait-for [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequested> + ] [--progress=<type>] [-t=<timeoutPeriod>] [-s=<states> + [,<states>…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-u=any-match|all-match | -w=any-match|all-match] + [[--session=<sessionName>]] report-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a report id (possibly stored using --store on of the 'report create' command) to wait for report generation to complete. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following statuses are currently known by fcli: +See fcli help output

+
+
+
+
+

Options

+
+
+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more scan states against which to match the report generation status.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until report generation status matches.

+
+
-w, --while=any-match|all-match
+
+

Wait while report generation status matches.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
report-id’s…​
+
+

Report id(s).

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-report.html b/v2.10.1/manpage/fcli-fod-report.html new file mode 100644 index 000000000..67b9d049b --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-report.html @@ -0,0 +1,111 @@ +--- +title: fcli-fod-report(1) +fcli_version: +--- + + + + + + + +fcli-fod-report(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod report [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List reports.

+
+
get
+
+

Get report details.

+
+
create
+
+

Create a new report.

+
+
delete, rm
+
+

Delete a report.

+
+
wait-for
+
+

Wait for report to reach or exit specified generation status.

+
+
download
+
+

Download a report.

+
+
list-templates, lst
+
+

List report templates.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-rest-call.html b/v2.10.1/manpage/fcli-fod-rest-call.html new file mode 100644 index 000000000..57d278161 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-rest-call.html @@ -0,0 +1,174 @@ +--- +title: fcli-fod-rest-call(1) +fcli_version: +--- + + + + + + + +fcli-fod-rest-call(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--no-transform] | -t=<expr>] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>] [[--session=<sessionName>]] <uri>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --data=<data>
+
+

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

+
+
--no-paging
+
+

By default, this command will load all pages of data from FoD (from the given offset if specified as a request parameter). Use this option to return only a single page.

+
+
--no-transform
+
+

By default, this command performs generic transformations on FoD REST responses, like only outputting the actual response data (contents of the 'items' property). Use this option to output the original response contents without transformations.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-t, --transform=<expr>
+
+

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

+
+
-X, --request=<httpMethod>
+
+

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<uri>
+
+

Relative URI to the REST API endpoint that you want to invoke.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-rest-lookup.html b/v2.10.1/manpage/fcli-fod-rest-lookup.html new file mode 100644 index 000000000..876cc9ddf --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-rest-lookup.html @@ -0,0 +1,155 @@ +--- +title: fcli-fod-rest-lookup(1) +fcli_version: +--- + + + + + + + +fcli-fod-rest-lookup(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod rest lookup [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>] [<type>]

+
+
+
+
+

Description

+
+
+

Use this command to retrieve the values of lookup items (types) that are used with various commands and when using the FoD REST API directly.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
[<type>]
+
+

The type of lookup items to return. Valid values: All, AnalysisStatusTypes, ApplicationTypes, AssessmentTypes, AttributeDataTypes, AttributeTypes, AuditActionTypes, AuditPreferenceTypes, AuditTemplateConditionTypes, BusinessCriticalityTypes, ConcurrentRequestThreadsTypes, DastAutomatedScanPolicies, DastAutomatedScanTypes, DataExportTypes, DayOfWeekTypes, DynamicMobileScanTypeAuditTemplateFieldTypes, DynamicScanAuthenticationTypes, DynamicScanEnvironmentFacingTypes, DynamicScanWebServiceTypes, EntitlementFrequencyTypes, GeoLocations, LanguageLevels, MobileScanAuditPreferenceTypes, MobileScanEnvironmentTypes, MobileScanExternalDeviceTypes, MobileScanFrameworkTypes, MobileScanPlatformTypes, MobileScanRoleTypes, MultiFactorAuthorizationTypes, NotificationTriggerTypes, OpenSourceScanTypeAuditTemplateFieldTypes, PassFailReasonTypes, RepeatScheduleTypes, ReportFormats, ReportStatusTypes, ReportTemplateTypes, ReportTypes, Roles, SDLCStatusTypes, ScanMethodTypes, ScanPreferenceTypes, ScanStatusTypes, ScanTypes, StartScanMethodTypes, StaticScanTypeAuditTemplateFieldTypes, TechnologyTypes, TimeZones, VulnerabilitySeverityTypes. Leave empty to list all the valid lookup items of the REST API.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-rest.html b/v2.10.1/manpage/fcli-fod-rest.html new file mode 100644 index 000000000..12eccc9a6 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-rest.html @@ -0,0 +1,93 @@ +--- +title: fcli-fod-rest(1) +fcli_version: +--- + + + + + + + +fcli-fod-rest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod rest [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

These commands allow for direct interaction with FoD REST API endpoints, somewhat similar to using 'curl' but benefiting from standard fcli functionality like session management (no need to manually specify Authorization header), rich output formatting options, and query functionality.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
call
+
+

Call an individual FoD REST API endpoint.

+
+
lookup
+
+

Retrieve FoD REST API lookup values.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-cancel.html b/v2.10.1/manpage/fcli-fod-sast-scan-cancel.html new file mode 100644 index 000000000..b87aa5457 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-cancel.html @@ -0,0 +1,139 @@ +--- +title: fcli-fod-sast-scan-cancel(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-cancel(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan cancel [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-download-latest.html b/v2.10.1/manpage/fcli-fod-sast-scan-download-latest.html new file mode 100644 index 000000000..f557e81c3 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-download-latest.html @@ -0,0 +1,149 @@ +--- +title: fcli-fod-sast-scan-download-latest(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-download-latest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan download-latest [--delim=<delimiter>] -f=<file> --rel=id|app + _ [:ms]:rel_ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-download.html b/v2.10.1/manpage/fcli-fod-sast-scan-download.html new file mode 100644 index 000000000..4bb8ef5b9 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-download.html @@ -0,0 +1,158 @@ +--- +title: fcli-fod-sast-scan-download(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan download [--delim=<delimiter>] -f=<file> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

File path and name where to save the FPR file.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-get-config.html b/v2.10.1/manpage/fcli-fod-sast-scan-get-config.html new file mode 100644 index 000000000..ab995adbc --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-get-config.html @@ -0,0 +1,146 @@ +--- +title: fcli-fod-sast-scan-get-config(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-get-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan get-config [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-get.html b/v2.10.1/manpage/fcli-fod-sast-scan-get.html new file mode 100644 index 000000000..5ec1d0587 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-fod-sast-scan-get(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-import.html b/v2.10.1/manpage/fcli-fod-sast-scan-import.html new file mode 100644 index 000000000..a1c42b51c --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-import.html @@ -0,0 +1,159 @@ +--- +title: fcli-fod-sast-scan-import(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan import [--chunk-size=<chunkSize>] [--delim=<delimiter>] + -f=<file> [--progress=<type>] --rel=id|app[:ms]:rel + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

As FoD doesn’t return a scan id for imported scans, the output of this command cannot be used with commands that expect a scan id, like the wait-for command.

+
+
+
+
+

Options

+
+
+
+
--chunk-size=<chunkSize>
+
+

Size of each chunk (in bytes) for file uploads. Default is 1048576.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

FPR file containing existing SAST scan results to be imported.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-list.html b/v2.10.1/manpage/fcli-fod-sast-scan-list.html new file mode 100644 index 000000000..069377dd4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-fod-sast-scan-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan list [--delim=<delimiter>] --rel=id|app[:ms]:rel [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-setup.html b/v2.10.1/manpage/fcli-fod-sast-scan-setup.html new file mode 100644 index 000000000..4589a35b4 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-setup.html @@ -0,0 +1,206 @@ +--- +title: fcli-fod-sast-scan-setup(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-setup(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan setup [--include-third-party-libs] [--oss] + [--skip-if-exists] [--use-aviator] + [--use-source-control] + --assessment-type=<staticAssessmentType> + --audit-preference=<auditPreferenceType> + [--delim=<delimiter>] + [--entitlement-id=<entitlementId>] + --frequency=<entitlementFrequencyType> + [--language-level=<languageLevel>] [--progress=<type>] + --rel=id|app[:ms]:rel + [--technology-stack=<technologyStack>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command is not fully implemented and is intended for preview only. Command name, options and behavior may change at any time, even between patch or minor releases, potentially affecting any workflows in which this command is being used. +To correctly setup a scan you will need to provide the name of the assessment type using the '--assessment-type=xxx' option. Since assessment types can potentially be configured differently for each tenant, you can find the correct name using the 'fod rest lookup AssessmentTypes' command. +If you know the Id of an entitlement that you want to use then you can supply it to the '--entitlement-id=xxx' option. If not, you can supply both '--assessment-type' and '--entitlement-frequency' options and the command will try to find an appropriate entitlement. +For the '--technology-stack' and '--language-level' options it is recommended to examine the drop-down list values in the FoD UI. However, you can also use the 'fod rest lookup' command. For example, to list all the technology stacks you would use 'fod rest lookup TechnologyTypes' and then for the language levels (if appropriate) you would use the 'Value' field returned in 'fod rest lookup LanguageLevels'. For example, for Java which is typically value '7', you would use 'fod rest lookup LanguageLevels -q "group=='7'".

+
+
+
+
+

Options

+
+
+
+
--assessment-type=<staticAssessmentType>
+
+

The type of Static assessment to carry out. Use 'release list-assessment-types' to find valid values.

+
+
--audit-preference=<auditPreferenceType>
+
+

Audit preference, e.g. Manual or Automated

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
--entitlement-id=<entitlementId>
+
+

Entitlement Id to use. If not specified Frequency and Assessment Type will be used to find one.

+
+
--frequency, --entitlement-frequency=<entitlementFrequencyType>
+
+

The entitlement frequency type to use. Valid values: SingleScan, Subscription.

+
+
--include-third-party-libs
+
+

(LEGACY) Indicates if third party libraries should be included.

+
+
--language-level=<languageLevel>
+
+

The language level of the technology stack (if needed).

+
+
--oss
+
+

Perform Open Source Analysis scan.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--skip-if-exists
+
+

Skip setup if a scan has already been set up. If not specified, any existing scan setup will be replaced based on the given setup options.

+
+
--technology-stack=<technologyStack>
+
+

The technology stack of the application. Default value: Auto Detect.

+
+
--use-aviator
+
+

Use Fortify Aviator to audit results and provide enhanced remediation guidance.

+
+
--use-source-control
+
+

(LEGACY) Indicates if source control should be used.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-start.html b/v2.10.1/manpage/fcli-fod-sast-scan-start.html new file mode 100644 index 000000000..84467cfd6 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-start.html @@ -0,0 +1,159 @@ +--- +title: fcli-fod-sast-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan start [--delim=<delimiter>] -f=<file> [--notes=<notes>] + --rel=id|app[:ms]:rel + [--remediation=<remediationScanPreferenceType>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

The scan will need to have been previously setup using the FoD UI or the 'fod sast-scan setup' command.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-f, --file=<file>
+
+

Absolute path of the ScanCentral package (.Zip) file to upload.

+
+
--notes=<notes>
+
+

Scan notes.

+
+
--rel, --release=id|app[:ms]:rel
+
+

Release id or <application>[:<microservice>]:<release> name.

+
+
--remediation, --remediation-preference=<remediationScanPreferenceType>
+
+

The remediation preference to use. Valid values: RemediationScanIfAvailable, RemediationScanOnly, NonRemediationScanOnly.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan-wait-for.html b/v2.10.1/manpage/fcli-fod-sast-scan-wait-for.html new file mode 100644 index 000000000..b77e08c18 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan-wait-for.html @@ -0,0 +1,216 @@ +--- +title: fcli-fod-sast-scan-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan wait-for [--delim=<delimiter>] [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequest + _ ed>_] [--progress=<type>] [-t=<timeoutPeriod>] + [-s=<states>[,<states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + scan-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a scan id (possibly stored using --store on one of the 'scan start-*' commands) to wait for scan completion. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following states are currently known by fcli: +See fcli help output

+
+
+

Please note it is recommended to pass the scan id’s as '<release-id>:<scan-id>' rather than just '<scan-id>'. If only '<scan-id>' is passed then its status might not be available yet, causing FoD to return a '404 - Not Found' error. It is recommended to pass a fcli variable to do this as it will automatically resolve to using <release-id>:<scan-id>. For example, to start a SAST scan and wait for it to complete, use:

+
+
+
+
fcli fod sast-scan start ... --store scan
+fcli fod sast-scan wait-for ::scan::
+
+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application[:microservice]:release" as an argument or parameter.

+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more scan states against which to match the given scans.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all scans match. If neither --until or --while are specified, default is to wait until all scans match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all scans match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id’s…​
+
+

Whitespace separated list of <release-id>:<scan-id> or <scan-id> items.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-sast-scan.html b/v2.10.1/manpage/fcli-fod-sast-scan.html new file mode 100644 index 000000000..db0e2cb89 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-sast-scan.html @@ -0,0 +1,123 @@ +--- +title: fcli-fod-sast-scan(1) +fcli_version: +--- + + + + + + + +fcli-fod-sast-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod sast-scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
cancel
+
+

Cancel a SAST scan.

+
+
download
+
+

Download scan results.

+
+
download-latest
+
+

Download latest scan results from release.

+
+
get
+
+

Get SAST scan details.

+
+
get-config
+
+

(PREVIEW) Get current SAST scan configuration.

+
+
import
+
+

Import existing SAST scan results (from an FPR file).

+
+
list, ls
+
+

List SAST scans.

+
+
setup
+
+

(PREVIEW) Configure SAST scan details for the release.

+
+
start
+
+

Start a new SAST scan.

+
+
wait-for
+
+

Wait for one or more SAST scans to reach or exit specified scan statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-session-list.html b/v2.10.1/manpage/fcli-fod-session-list.html new file mode 100644 index 000000000..d9d4cc09a --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-session-list.html @@ -0,0 +1,126 @@ +--- +title: fcli-fod-session-list(1) +fcli_version: +--- + + + + + + + +fcli-fod-session-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod session list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

This commands lists all FoD sessions created through the 'login' command, as long as they haven’t been explicitly terminated through the 'logout' command.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-session-login.html b/v2.10.1/manpage/fcli-fod-session-login.html new file mode 100644 index 000000000..ce41daf3c --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-session-login.html @@ -0,0 +1,221 @@ +--- +title: fcli-fod-session-login(1) +fcli_version: +--- + + + + + + + +fcli-fod-session-login(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod session login [-k] [--connect-timeout=<connectTimeout>] + [--session=<sessionName>] + [--socket-timeout=<socketTimeout>] --url=<url> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] ([--scopes=<scopes>[, + <scopes>…​]]…​ -u=<user> -p[=<password>] -t=<tenant>) | (--client-id=<clientId> --client-secret [=<clientSecret>])

+
+
+
+
+

Description

+
+
+

This command stores the FoD URL and authentication token in an encrypted session file in the fcli state data folder, for use by other 'fcli fod' commands to connect to the specified FoD instance. Option values may be passed on the command line or specified through environment variables (common for CI/CD pipeline use) as listed below.

+
+
+

For interactive use, you may choose to keep the session open until it expires. For CI/CD integrations and other automations, you should always issue a logout command once work is complete. On shared/non-containerized systems, consider setting FCLI_STATE_DIR or FCLI_DATA_DIR environment variables to prevent unexpected interactions between different pipelines.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name for this FoD session. Default value: default.

+
+
--scopes=<scopes>[,<scopes>…​]
+
+

FoD scopes to request. Default value: api-tenant

+
+
-u, --user=<user>
+
+

FoD user.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_USER
+
+
+
+
-p, --password[=<password>]
+
+

FoD password.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_PASSWORD
+
+
+
+
-t, --tenant=<tenant>
+
+

FoD tenant.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_TENANT
+
+
+
+
--client-id=<clientId>
+
+

FoD client id.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_CLIENT_ID
+
+
+
+
--client-secret[=<clientSecret>]
+
+

FoD client secret.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_CLIENT_SECRET
+
+
+
+
--url=<url>
+
+

FoD API URL, for example https://api.emea.fortify.com/.

+
+

Environment variable:

+
+
+
+
FCLI_DEFAULT_FOD_URL
+
+
+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: null.

+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: null.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-session-logout.html b/v2.10.1/manpage/fcli-fod-session-logout.html new file mode 100644 index 000000000..52dd23b9f --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-session-logout.html @@ -0,0 +1,127 @@ +--- +title: fcli-fod-session-logout(1) +fcli_version: +--- + + + + + + + +fcli-fod-session-logout(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod session logout [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command terminates an FoD session previously created through the 'login' command. This command removes the session data from the fcli state data directory.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name of the FoD session to be terminated. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod-session.html b/v2.10.1/manpage/fcli-fod-session.html new file mode 100644 index 000000000..9c3114c04 --- /dev/null +++ b/v2.10.1/manpage/fcli-fod-session.html @@ -0,0 +1,97 @@ +--- +title: fcli-fod-session(1) +fcli_version: +--- + + + + + + + +fcli-fod-session(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod session [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The session commands allow for managing one or more FoD sessions used to connect to a particular FoD instance with particular credentials. Potentially you can have multiple open FoD sessions, for example connecting to different FoD instances like AMS and EMEA, or connecting to the same FoD instance but with different tenant or credentials.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List active and expired FoD sessions.

+
+
login
+
+

Login to FoD.

+
+
logout
+
+

Terminate FoD session.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-fod.html b/v2.10.1/manpage/fcli-fod.html new file mode 100644 index 000000000..e56a797bf --- /dev/null +++ b/v2.10.1/manpage/fcli-fod.html @@ -0,0 +1,140 @@ +--- +title: fcli-fod(1) +fcli_version: +--- + + + + + + + +fcli-fod(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli fod [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for interacting with Fortify on Demand (FoD). This includes functionality like managing applications, releases and microservices, and for submitting and managing SAST, DAST and open-source scan requests and results.

+
+
+

Before being able to interact with FoD, a session will need to be created by passing FoD URL and credentials to the 'session login' command in this module. As a best practice, 'session logout' should be run to terminate the session when there are no more activities to be performed.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
session
+
+

Manage FoD sessions (start here).

+
+
action
+
+

Manage FoD actions: data export, integration, automation & more.

+
+
access-control, ac
+
+

Manage FoD users & groups.

+
+
app
+
+

Manage FoD applications.

+
+
microservice, ms
+
+

Manage FoD application microservices.

+
+
release, rel
+
+

Manage FoD application releases.

+
+
sast-scan, sast
+
+

Manage FoD SAST scans.

+
+
dast-scan, dast
+
+

Manage FoD DAST scans.

+
+
mast-scan, mast
+
+

Manage FoD MAST scans.

+
+
oss-scan, oss
+
+

Manage FoD OSS scans.

+
+
issue
+
+

Manage FoD issues (vulnerabilities) and related entities.

+
+
report
+
+

Manage FoD reports.

+
+
rest
+
+

Interact with FoD REST API endpoints.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-msp-report-create-config.html b/v2.10.1/manpage/fcli-license-msp-report-create-config.html new file mode 100644 index 000000000..7ab355833 --- /dev/null +++ b/v2.10.1/manpage/fcli-license-msp-report-create-config.html @@ -0,0 +1,131 @@ +--- +title: fcli-license-msp-report-create-config(1) +fcli_version: +--- + + + + + + + +fcli-license-msp-report-create-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license msp-report create-config [-y] [-c=<outputFileName>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-c, --config=<outputFileName>
+
+

Name of the sample configuration file to be generated.

+
+
-y, --confirm
+
+

Confirm overwrite of existing configuration file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-msp-report-create.html b/v2.10.1/manpage/fcli-license-msp-report-create.html new file mode 100644 index 000000000..fe22b43c4 --- /dev/null +++ b/v2.10.1/manpage/fcli-license-msp-report-create.html @@ -0,0 +1,171 @@ +--- +title: fcli-license-msp-report-create(1) +fcli_version: +--- + + + + + + + +fcli-license-msp-report-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license msp-report create [-y] [-c=<configFile>] -e=<reportingEndDate> + [--progress=<type>] -s=<reportingStartDate> + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + (-z=<reportZipName> | -d=<reportDirName>) + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command generates a 'Managed Service Provider' (MSP) report based on configuration settings defined in a configuration file. A sample configuration file can be generated using the 'fcli license msp-report create-config' command.

+
+
+

The configuration file includes settings for specifying one or more SSC instances from which to load MSP reporting data, and for specifying MSP (contract) information.

+
+
+

The generated report consists of multiple files, written to either a directory or zip-file. The primary output file is 'summary.txt' that contains various statistics, including the number of application and scan entitlements consumed during the reporting period. Various CSV files providing proof, like the number of entitlements consumed per application, what artifacts were processed, and which artifacts contributed to the entitlement consumption, are generated in the details directory of the report.

+
+
+

The generated 'checksums.sha256' file can be used to verify integrity of all generated files, using a command like 'sha256sum -c checksums.sha256'.

+
+
+

This command requires the following SSC application version attributes to be configured in SSC: +- MSP_License_Type: Required, Single-Select List, Values: Application, Scan, Demo +- MSP_End_Customer_Name - Optional (for demo applications), Single Line Text +- MSP_End_Customer_Location - Optional (for demo applications), Single Line Text

+
+
+

Note that all versions within a single application should provide the same values for these attributes.

+
+
+
+
+

Options

+
+
+
+
-c, --config=<configFile>
+
+

Configuration file; sample can be generated using the 'create-config' command.

+
+
-d, --report-dir=<reportDirName>
+
+

Write report output to the given directory.

+
+
-e, --end-date=<reportingEndDate>
+
+

Reporting period start date. Format: yyyy-MM-dd, for example 2023-03-31.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --start-date=<reportingStartDate>
+
+

Reporting period start date. Format: yyyy-MM-dd, for example 2023-01-01.

+
+
-y, --confirm
+
+

Confirm delete of existing report output location.

+
+
-z, --report-zip=<reportZipName>
+
+

Write report output to the given zip-file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-msp-report.html b/v2.10.1/manpage/fcli-license-msp-report.html new file mode 100644 index 000000000..b5d094428 --- /dev/null +++ b/v2.10.1/manpage/fcli-license-msp-report.html @@ -0,0 +1,91 @@ +--- +title: fcli-license-msp-report(1) +fcli_version: +--- + + + + + + + +fcli-license-msp-report(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license msp-report [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
create
+
+

Generate a 'Managed Service Provider' (MSP) report.

+
+
create-config
+
+

Generate a sample configuration file for use by the 'generate' command.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-ncd-report-create-config.html b/v2.10.1/manpage/fcli-license-ncd-report-create-config.html new file mode 100644 index 000000000..c1fec165c --- /dev/null +++ b/v2.10.1/manpage/fcli-license-ncd-report-create-config.html @@ -0,0 +1,131 @@ +--- +title: fcli-license-ncd-report-create-config(1) +fcli_version: +--- + + + + + + + +fcli-license-ncd-report-create-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license ncd-report create-config [-y] [-c=<outputFileName>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-c, --config=<outputFileName>
+
+

Name of the sample configuration file to be generated.

+
+
-y, --confirm
+
+

Confirm overwrite of existing configuration file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-ncd-report-create.html b/v2.10.1/manpage/fcli-license-ncd-report-create.html new file mode 100644 index 000000000..c8c810cc3 --- /dev/null +++ b/v2.10.1/manpage/fcli-license-ncd-report-create.html @@ -0,0 +1,153 @@ +--- +title: fcli-license-ncd-report-create(1) +fcli_version: +--- + + + + + + + +fcli-license-ncd-report-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license ncd-report create [-y] [-c=<configFile>] [--progress=<type>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + (-z=<reportZipName> | -d=<reportDirName>) + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command generates a 'Number of Contributing Developers' (NCD) report based on configuration settings defined in a configuration file. A sample configuration file can be generated using the 'fcli license ncd-report create-config' command.

+
+
+

The configuration file includes rich settings for specifying the source code repositories from which to load contributing developer data (supporting multiple Source Code Management (SCM) systems), and for ignoring and de-duplicating contributing authors.

+
+
+

The generated report consists of multiple files, written to either a directory or zip-file. The primary output file is 'summary.txt' that contains various statistics, including the de-duplicated count of contributing developers. Various CSV files are generated with supporting proof, like the list of contributing authors, the list of commits that have been processed, and the list of repositories that have been processed.

+
+
+

The generated 'checksums.sha256' file can be used to verify integrity of all generated files, using a command like 'sha256sum -c checksums.sha256'.

+
+
+
+
+

Options

+
+
+
+
-c, --config=<configFile>
+
+

Configuration file; sample can be generated using the 'create-config' command.

+
+
-d, --report-dir=<reportDirName>
+
+

Write report output to the given directory.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-y, --confirm
+
+

Confirm delete of existing report output location.

+
+
-z, --report-zip=<reportZipName>
+
+

Write report output to the given zip-file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license-ncd-report.html b/v2.10.1/manpage/fcli-license-ncd-report.html new file mode 100644 index 000000000..702e7b312 --- /dev/null +++ b/v2.10.1/manpage/fcli-license-ncd-report.html @@ -0,0 +1,91 @@ +--- +title: fcli-license-ncd-report(1) +fcli_version: +--- + + + + + + + +fcli-license-ncd-report(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license ncd-report [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
create
+
+

Generate a 'Number of Contributing Developers' (NCD) report.

+
+
create-config
+
+

Generate a sample configuration file for use by the 'generate' command.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-license.html b/v2.10.1/manpage/fcli-license.html new file mode 100644 index 000000000..ae2254867 --- /dev/null +++ b/v2.10.1/manpage/fcli-license.html @@ -0,0 +1,93 @@ +--- +title: fcli-license(1) +fcli_version: +--- + + + + + + + +fcli-license(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli license [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

This module provides various commands related to Fortify licensing & license reporting.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
msp-report
+
+

Configure and generate 'Managed Service Provider' (MSP) reports.

+
+
ncd-report
+
+

Configure and generate 'Number of Contributing Developers' (NCD) reports.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-rest-call.html b/v2.10.1/manpage/fcli-sc-dast-rest-call.html new file mode 100644 index 000000000..c856e1e1a --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-rest-call.html @@ -0,0 +1,174 @@ +--- +title: fcli-sc-dast-rest-call(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-rest-call(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--no-transform] | -t=<expr>] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>] [[--session=<sessionName>]] <uri>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --data=<data>
+
+

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

+
+
--no-paging
+
+

By default, this command will load all pages of data from ScanCentral DAST (from the given offset if specified as a request parameter). Use this option to return only a single page.

+
+
--no-transform
+
+

By default, this command performs generic transformations on ScanCentral DAST REST responses, like only outputting the actual response data (contents of the 'item' or 'items' property). Use this option to output the original response contents without transformations.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-t, --transform=<expr>
+
+

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

+
+
-X, --request=<httpMethod>
+
+

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<uri>
+
+

Relative URI to the REST API endpoint that you want to invoke.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-rest.html b/v2.10.1/manpage/fcli-sc-dast-rest.html new file mode 100644 index 000000000..fec7dffeb --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-rest.html @@ -0,0 +1,89 @@ +--- +title: fcli-sc-dast-rest(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-rest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast rest [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

These commands allow for direct interaction with ScanCentral DAST REST API endpoints, somewhat similar to using 'curl' but benefiting from standard fcli functionality like session management (no need to manually specify Authorization header), rich output formatting options, and query functionality.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
call
+
+

Call an individual Fortify ScanCentral DAST REST API endpoint.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-complete.html b/v2.10.1/manpage/fcli-sc-dast-scan-complete.html new file mode 100644 index 000000000..34ca2791f --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-complete.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-scan-complete(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-complete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan complete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-delete.html b/v2.10.1/manpage/fcli-sc-dast-scan-delete.html new file mode 100644 index 000000000..ce65a4609 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-delete.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-scan-delete(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan delete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-download.html b/v2.10.1/manpage/fcli-sc-dast-scan-download.html new file mode 100644 index 000000000..840e880a5 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-download.html @@ -0,0 +1,158 @@ +--- +title: fcli-sc-dast-scan-download(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan download [-f=<file>] -t=<type> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Optional output file name.

+
+
-t, --type=<type>
+
+

Artifact type to download: fpr, logs, results, settings, site-tree.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-get.html b/v2.10.1/manpage/fcli-sc-dast-scan-get.html new file mode 100644 index 000000000..f07e91e56 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-sc-dast-scan-get(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-import-findings.html b/v2.10.1/manpage/fcli-sc-dast-scan-import-findings.html new file mode 100644 index 000000000..514f9607a --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-import-findings.html @@ -0,0 +1,143 @@ +--- +title: fcli-sc-dast-scan-import-findings(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-import-findings(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan import-findings [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + scan-id

+
+
+
+
+

Description

+
+
+

This command imports scan findings into ScanCentral DAST. With ScanCentral DAST, scan findings are usually imported automatically, but there may be cases where this operation needs to be triggered explicitly. Please see the ScanCentral DAST documentation for more information.

+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-list.html b/v2.10.1/manpage/fcli-sc-dast-scan-list.html new file mode 100644 index 000000000..4b638291c --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-list.html @@ -0,0 +1,144 @@ +--- +title: fcli-sc-dast-scan-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan list [--server-queries=<name=value>[,<name=value>…​]]…​ + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--server-queries=<name=value>[,<name=value>…​]
+
+

Complementary to the -q / --query option (which performs client-side filtering), this option accepts one or more comma-separated ScanCentral DAST request parameters to perform server-side filtering, for example 'searchText=some-text'. See the ScanCentral DAST API documentation for information on which request parameters are supported on individual endpoints.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-pause.html b/v2.10.1/manpage/fcli-sc-dast-scan-pause.html new file mode 100644 index 000000000..d0b1d468c --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-pause.html @@ -0,0 +1,138 @@ +--- +title: fcli-sc-dast-scan-pause(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-pause(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan pause [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-policy-get.html b/v2.10.1/manpage/fcli-sc-dast-scan-policy-get.html new file mode 100644 index 000000000..d04923d76 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-policy-get.html @@ -0,0 +1,140 @@ +--- +title: fcli-sc-dast-scan-policy-get(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-policy-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-policy get [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <scanPolicyNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<scanPolicyNameOrId>
+
+

Scan policy name or id

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-policy-list.html b/v2.10.1/manpage/fcli-sc-dast-scan-policy-list.html new file mode 100644 index 000000000..2f0862bb0 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-policy-list.html @@ -0,0 +1,140 @@ +--- +title: fcli-sc-dast-scan-policy-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-policy-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-policy list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-policy.html b/v2.10.1/manpage/fcli-sc-dast-scan-policy.html new file mode 100644 index 000000000..5404bf03b --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-policy.html @@ -0,0 +1,91 @@ +--- +title: fcli-sc-dast-scan-policy(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-policy(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-policy [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get
+
+

Get the details for a single scan policy.

+
+
list, ls
+
+

List scan policies.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-publish.html b/v2.10.1/manpage/fcli-sc-dast-scan-publish.html new file mode 100644 index 000000000..a854f6e90 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-publish.html @@ -0,0 +1,141 @@ +--- +title: fcli-sc-dast-scan-publish(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-publish(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan publish [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+
+

This command publishes scan results to SSC. This can be used for publishing the results if 'Submit for Triage' was not enabled in the scan configuration.

+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-resume.html b/v2.10.1/manpage/fcli-sc-dast-scan-resume.html new file mode 100644 index 000000000..a82491603 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-resume.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-scan-resume(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-resume(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan resume [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id
+
+

Single scan id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-settings-get.html b/v2.10.1/manpage/fcli-sc-dast-scan-settings-get.html new file mode 100644 index 000000000..8c26ca2b2 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-settings-get.html @@ -0,0 +1,140 @@ +--- +title: fcli-sc-dast-scan-settings-get(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-settings-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-settings get [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <scanSettingsCicdTokenOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<scanSettingsCicdTokenOrId>
+
+

Scan settings CI/CD token or id

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-settings-list.html b/v2.10.1/manpage/fcli-sc-dast-scan-settings-list.html new file mode 100644 index 000000000..9369dabf7 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-settings-list.html @@ -0,0 +1,147 @@ +--- +title: fcli-sc-dast-scan-settings-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-settings-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-settings list [--server-queries=<name=value>[, + <name=value>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--server-queries=<name=value>[,<name=value>…​]
+
+

Complementary to the -q / --query option (which performs client-side filtering), this option accepts one or more comma-separated ScanCentral DAST request parameters to perform server-side filtering, for example 'searchText=some-text'. See the ScanCentral DAST API documentation for information on which request parameters are supported on individual endpoints.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-settings.html b/v2.10.1/manpage/fcli-sc-dast-scan-settings.html new file mode 100644 index 000000000..43b99bcae --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-settings.html @@ -0,0 +1,91 @@ +--- +title: fcli-sc-dast-scan-settings(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-settings(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan-settings [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get
+
+

Get the details for a single scan settings definition.

+
+
list, ls
+
+

List scan settings.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-start.html b/v2.10.1/manpage/fcli-sc-dast-scan-start.html new file mode 100644 index 000000000..aef0bc892 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-start.html @@ -0,0 +1,162 @@ +--- +title: fcli-sc-dast-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan start [-l=<loginMacroBinaryFileId>] [-m=<scanMode>] + -n=<scanName> [--overrides-file=<overridesFile>] + [-p=<scanPolicyNameOrId>] + -s=<scanSettingsCicdTokenOrId> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-l, --login-macro=<loginMacroBinaryFileId>
+
+

Overrides the scan login macro binary file id.

+
+
-m, --mode=<scanMode>
+
+

Overrides the scan mode. Accepted values are: CrawlOnly, CrawlAndAudit, AuditOnly.

+
+
-n, --name=<scanName>
+
+

The name for this scan.

+
+
--overrides-file=<overridesFile>
+
+

File containing override values for the scan.

+
+
-p, --policy=<scanPolicyNameOrId>
+
+

Scan policy name or id

+
+
-s, --settings=<scanSettingsCicdTokenOrId>
+
+

Scan settings CI/CD token or id

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan-wait-for.html b/v2.10.1/manpage/fcli-sc-dast-scan-wait-for.html new file mode 100644 index 000000000..cb35751e3 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan-wait-for.html @@ -0,0 +1,203 @@ +--- +title: fcli-sc-dast-scan-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan wait-for [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequeste + _ d>_] [--progress=<type>] [-t=<timeoutPeriod>] + [-s=<states>[,<states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + scan-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a scan id (possibly stored using --store on the 'scan start' command) to wait for completion of a single scan. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following states are currently known by fcli: +See fcli help output

+
+
+
+
+

Options

+
+
+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more scan states against which to match the given scans.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all scans match. If neither --until or --while are specified, default is to wait until all scans match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all scans match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-id’s…​
+
+

One or more scan id’s.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-scan.html b/v2.10.1/manpage/fcli-sc-dast-scan.html new file mode 100644 index 000000000..0bb32db4c --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-scan.html @@ -0,0 +1,127 @@ +--- +title: fcli-sc-dast-scan(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
complete
+
+

Complete a scan.

+
+
delete, rm
+
+

Delete a scan.

+
+
download
+
+

Download scan fpr, logs, results, settings or site tree.

+
+
get
+
+

Get the details for a single scan.

+
+
import-findings
+
+

Import scan findings.

+
+
list, ls
+
+

List and query scans.

+
+
pause
+
+

Pause a scan.

+
+
publish
+
+

Publish scan results.

+
+
resume
+
+

Resume a scan

+
+
start
+
+

Start a new scan.

+
+
wait-for
+
+

Wait for one or more scans to reach or exit specified scan statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-sensor-disable.html b/v2.10.1/manpage/fcli-sc-dast-sensor-disable.html new file mode 100644 index 000000000..9c96ee604 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-sensor-disable.html @@ -0,0 +1,140 @@ +--- +title: fcli-sc-dast-sensor-disable(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-sensor-disable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast sensor disable [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <sensorNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<sensorNameOrId>
+
+

Sensor name or id

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-sensor-enable.html b/v2.10.1/manpage/fcli-sc-dast-sensor-enable.html new file mode 100644 index 000000000..12f98ffd9 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-sensor-enable.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-sensor-enable(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-sensor-enable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast sensor enable [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <sensorNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<sensorNameOrId>
+
+

Sensor name or id

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-sensor-get.html b/v2.10.1/manpage/fcli-sc-dast-sensor-get.html new file mode 100644 index 000000000..744a4ccb3 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-sensor-get.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-sensor-get(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-sensor-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast sensor get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <sensorNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<sensorNameOrId>
+
+

Sensor name or id

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-sensor-list.html b/v2.10.1/manpage/fcli-sc-dast-sensor-list.html new file mode 100644 index 000000000..5e1e70a7d --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-sensor-list.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-dast-sensor-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-sensor-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast sensor list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-sensor.html b/v2.10.1/manpage/fcli-sc-dast-sensor.html new file mode 100644 index 000000000..0b3fcf89b --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-sensor.html @@ -0,0 +1,99 @@ +--- +title: fcli-sc-dast-sensor(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-sensor(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast sensor [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
disable
+
+

Disable a sensor.

+
+
enable
+
+

enable a sensor.

+
+
get
+
+

Get the details for a single sensor.

+
+
list, ls
+
+

List sensors.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-session-list.html b/v2.10.1/manpage/fcli-sc-dast-session-list.html new file mode 100644 index 000000000..2de0860d7 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-session-list.html @@ -0,0 +1,133 @@ +--- +title: fcli-sc-dast-session-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-session-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast session list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

This commands lists all ScanCentral DAST sessions created through the login command, as long as they haven’t been explicitly terminated through the 'logout' command.

+
+
+

For sessions created using user name and password, the output of this command will show session expiry date and status, based on the data provided by SSC at the time the login command was issued. Any changes to the generated token will not be reflected in the output of this command. Even if a session is no longer valid because the generated token was revoked (through SSC UI or 'fcli ssc access-control revoke-token' command), the output of this command may still show the session as not having expired. Similarly, any changes to token validity will not be reflected in the output of this command.

+
+
+

For sessions created using a pre-generated token, fcli cannot display session expiration date or status, as SSC doesn’t allow for obtaining this information.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-session-login.html b/v2.10.1/manpage/fcli-sc-dast-session-login.html new file mode 100644 index 000000000..7526faabc --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-session-login.html @@ -0,0 +1,226 @@ +--- +title: fcli-sc-dast-session-login(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-session-login(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast session login [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] ([-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --ssc-url=<url>) ((-u=<user> -p[=<password>] + [--expire-in=<expireIn>]) | -t[=<token>])

+
+
+
+
+

Description

+
+
+

This command stores the SSC and ScanCentral DAST API URL and authentication token in an encrypted session file in the fcli state data folder, for use by other 'fcli sc-dast' commands to connect to the specified SSC/ScanCentral DAST instance. Option values may be passed on the command line or specified through environment variables (common for CI/CD pipeline use) as listed below.

+
+
+

When logging in with username and password, this command will connect to SSC to generate a CIToken; the user password is not stored by fcli. When logging in with a pre-generated CIToken, this token will be stored as-is after checking its validity. Note that on SSC 23.2 or below, fcli cannot determine when a pre-generated token will expire.

+
+
+

For interactive use, you may choose to keep the session open until it expires. For CI/CD integrations and other automations, you should always issue a logout command once work is complete. On shared/non-containerized systems, consider setting FCLI_STATE_DIR or FCLI_DATA_DIR environment variables to prevent unexpected interactions between different pipelines.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name for this ScanCentral DAST session. Default value: default.

+
+
-u, --ssc-user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_USER: Only SC DAST commands
+
+
+
+
-p, --ssc-password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_PASSWORD: Only SC DAST commands
+
+
+
+
--expire-in=<expireIn>
+
+

Specify for how long the session should remain active, for example 1d (1 day), 2M (2 months), 1y (1 year).

+
+
+
Default: 3d
+
+
+
+
-t, --ssc-ci-token[=<token>]
+
+

SSC CIToken in either encoded (REST) or decoded (application) format.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_CI_TOKEN: Only SC DAST commands
+
+
+
+
--ssc-url=<url>
+
+

SSC URL.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_URL: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_URL: Only SC DAST commands
+
+
+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 60 seconds.

+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-session-logout.html b/v2.10.1/manpage/fcli-sc-dast-session-logout.html new file mode 100644 index 000000000..51f9b9f71 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-session-logout.html @@ -0,0 +1,175 @@ +--- +title: fcli-sc-dast-session-logout(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-session-logout(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast session logout [--no-revoke-token] [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=<user> -p + [=<password>]]

+
+
+
+
+

Description

+
+
+

This command terminates a ScanCentral DAST session previously created through the 'login' command.

+
+
+

If the session was created with user credentials, this command will revoke the automatically generated SSC token unless the --no-revoke-token option is specified. On SSC 24.2 or above, the automatically generated token can be revoked without providing user credentials. For SSC 23.2 or below, user credentials are required to revoke the automatically generated token; the logout command will throw an error if neither user credentials nor --no-revoke-token option is specified, and the session will not be terminated.

+
+
+

If the session was created with a pre-generated token, the session will always be terminated without revoking the pre-generated token. As such, no user credentials need to be provided, and the --no-revoke-token option will have no effect.

+
+
+

To summarize: No user credentials nor --no-revoke-token option should be specified if the session was created with a pre-generated SSC token or if the session is connected to SSC 24.2 or above. Either user credentials or --no-revoke-token option must be specified if the session was created with user credentials AND the session is connected to SSC 23.2 or below.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral DAST session to be terminated. Default value: default.

+
+
-u, --ssc-user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_USER: Only SC DAST commands
+
+
+
+
-p, --ssc-password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SSC/SC SAST
+
+
+
+
+
FCLI_DEFAULT_SC_DAST_SSC_PASSWORD: Only SC DAST commands
+
+
+
+
--no-revoke-token
+
+

It is highly recommended to have fcli revoke the token that was automatically generated if the session was created using user credentials to avoid exceeding SSCs maximum token limit. This option is provided for convenience only, to allow the session to be terminated without having to specify user credentials on SSC 23.2 or below. Once most users have upgraded to SSC 24.2 or above, this option will be deprecated or removed.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast-session.html b/v2.10.1/manpage/fcli-sc-dast-session.html new file mode 100644 index 000000000..aba45d65e --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast-session.html @@ -0,0 +1,97 @@ +--- +title: fcli-sc-dast-session(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast-session(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast session [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The session commands allow for managing one or more ScanCentral DAST sessions used to connect to a particular SSC/ScanCentral DAST environment with particular credentials. Potentially you can have multiple open ScanCentral DAST sessions, for example connecting to different SSC/ScanCentral DAST environments like DEV and PROD, or connecting to the same SSC/ScanCentral DAST instance but with different credentials.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List active and expired ScanCentral DAST sessions.

+
+
login
+
+

Create a session for interacting with ScanCentral DAST.

+
+
logout
+
+

Terminate ScanCentral DAST session.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-dast.html b/v2.10.1/manpage/fcli-sc-dast.html new file mode 100644 index 000000000..981ac9e37 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-dast.html @@ -0,0 +1,112 @@ +--- +title: fcli-sc-dast(1) +fcli_version: +--- + + + + + + + +fcli-sc-dast(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-dast [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for interacting with Fortify ScanCentral DAST (SC-DAST). This includes functionality like submitting and managing DAST scan requests and results.

+
+
+

Before being able to interact with ScanCentral DAST, a session will need to be created by passing SSC URL and credentials to the 'session login' command in this module. As a best practice, 'session logout' should be run to terminate the session when there are no more activities to be performed.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
session
+
+

Manage ScanCentral DAST sessions (start here).

+
+
scan
+
+

Manage ScanCentral DAST scans and results.

+
+
scan-policy
+
+

Manage ScanCentral DAST scan policies.

+
+
scan-settings
+
+

Manage ScanCentral DAST scan settings.

+
+
sensor
+
+

Manage ScanCentral DAST sensors.

+
+
rest
+
+

Interact with ScanCentral DAST REST API endpoints.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-rest-call.html b/v2.10.1/manpage/fcli-sc-sast-rest-call.html new file mode 100644 index 000000000..d270e40f2 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-rest-call.html @@ -0,0 +1,174 @@ +--- +title: fcli-sc-sast-rest-call(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-rest-call(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--no-transform] | -t=<expr>] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>] [[--session=<sessionName>]] <uri>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --data=<data>
+
+

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

+
+
--no-paging
+
+

This option currently has no effect for ScanCentral SAST.

+
+
--no-transform
+
+

This option currently has no effect for ScanCentral SAST.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-t, --transform=<expr>
+
+

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

+
+
-X, --request=<httpMethod>
+
+

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<uri>
+
+

Relative URI to the REST API endpoint that you want to invoke.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-rest.html b/v2.10.1/manpage/fcli-sc-sast-rest.html new file mode 100644 index 000000000..13e76b3b3 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-rest.html @@ -0,0 +1,89 @@ +--- +title: fcli-sc-sast-rest(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-rest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast rest [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

These commands allow for direct interaction with ScanCentral SAST Controller REST API endpoints, somewhat similar to using 'curl' but benefiting from standard fcli functionality like session management (no need to manually specify Authorization header), rich output formatting options, and query functionality.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
call
+
+

Call an individual ScanCentral SAST Controller REST API endpoint.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-scan-cancel.html b/v2.10.1/manpage/fcli-sc-sast-scan-cancel.html new file mode 100644 index 000000000..965a0733d --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-scan-cancel.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-sast-scan-cancel(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-scan-cancel(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast scan cancel [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-job-token

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-job-token
+
+

Scan job token.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-scan-start.html b/v2.10.1/manpage/fcli-sc-sast-scan-start.html new file mode 100644 index 000000000..071c6a809 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-scan-start.html @@ -0,0 +1,213 @@ +--- +title: fcli-sc-sast-scan-start(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-scan-start(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast scan start [--delim=<delimiter>] [--notify=<email>] + [--pool=<sensorPoolNameOrUuid>] + [--publish-to=<appVersionNameOrId>] + [--sargs=<scanArguments>] [--ssc-ci-token=<ciToken>] + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + (-m=<mbsFile> | (-v=<sensorVersion> -p=<packageFile>)) + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--notify=<email>
+
+

Email address to which to send a scan completion notification.

+
+
--pool, --sensor-pool=<sensorPoolNameOrUuid>
+
+

Sensor pool Uuid or Name.

+
+
--publish-to=<appVersionNameOrId>
+
+

Publish scan results to the given SSC application version once the scan has completed.

+
+
--sargs, --scan-args=<scanArguments>
+
+

Fortify Static Code Analyzer scan arguments, see ScanCentral SAST documentation for supported scan arguments for your ScanCentral SAST version. Multiple scan arguments must be provided as a single option argument, arguments containing spaces must be embedded in single quotes, and local files must be referenced through the 'file:' prefix. Note that contrary to fcli, scan arguments usually start with a single dash, not double dashes. For example:

+
+
+
--sargs "-quick -filter 'file:./my filters.txt'"
+
+
+
+
--ssc-ci-token=<ciToken>
+
+

SSC CIToken in either encoded (REST) or decoded (application) format.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_CI_TOKEN: Only SC SAST commands
+
+
+
+
+
+
+
+
+

Options for scanning an MBS file:

+
+
+
+
-m, --mbs-file=<mbsFile>
+
+

MBS file to scan.

+
+
+
+
+
+
+

Options for scanning a package file:

+
+
+
+
-p, --package-file=<packageFile>
+
+

Package file to scan.

+
+
-v, --sensor-version=<sensorVersion>
+
+

Version of the sensor on which the package should be scanned. Officially, you should select the same sensor version as the version of the ScanCentral Client used to create the package.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-scan-status.html b/v2.10.1/manpage/fcli-sc-sast-scan-status.html new file mode 100644 index 000000000..e4ea8b323 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-scan-status.html @@ -0,0 +1,139 @@ +--- +title: fcli-sc-sast-scan-status(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-scan-status(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast scan status [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] scan-job-token

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-job-token
+
+

Scan job token.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-scan-wait-for.html b/v2.10.1/manpage/fcli-sc-sast-scan-wait-for.html new file mode 100644 index 000000000..f26d97e84 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-scan-wait-for.html @@ -0,0 +1,221 @@ +--- +title: fcli-sc-sast-scan-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-scan-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast scan wait-for [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequeste + _ d>_] [--progress=<type>] [-t=<timeoutPeriod>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + [--any-scan-state=<scanStates>[,<scanStates>…​] + [--any-scan-state=<scanStates>[,<scanStates>…​]]…​ + | --any-publish-state=<publishStates>[, + <publishStates>…​] + [--any-publish-state=<publishStates>[, + <publishStates>…​]]…​ | --any-ssc-state=<sscStates> + [,<sscStates>…​] [--any-ssc-state=<sscStates>[, + <sscStates>…​]]…​] scan-job-tokens…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass a scan id (possibly stored using --store on the 'scan start' command) to wait until either the scan has been fully processed on SSC (if --publish-to was specified on the 'scan start' command and ScanCentral Controller version > 22.1), until the scan has been published to SSC (if --publish-to was specified on the 'scan start' command and ScanCentral Controller version ⇐ 22.1), or until the scan was completed (if --publish-to was not specified on the 'scan start' command).

+
+
+

The following scan/publish states are currently known by fcli: +See fcli help output

+
+
+

The following SSC artifact processing states are currently known by fcli: +See fcli help output

+
+
+
+
+

Options

+
+
+
+
--any-publish-state=<publishStates>[,<publishStates>…​]
+
+

One or more scan publishing states against which to match the given scans.

+
+
--any-scan-state=<scanStates>[,<scanStates>…​]
+
+

One or more scan states against which to match the given scans.

+
+
--any-ssc-state=<sscStates>[,<sscStates>…​]
+
+

One or more SSC artifact processing states against which to match the given scans.

+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all scans match. If neither --until or --while are specified, default is to wait until all scans match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all scans match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
scan-job-tokens…​
+
+

Scan job token.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-scan.html b/v2.10.1/manpage/fcli-sc-sast-scan.html new file mode 100644 index 000000000..fb5685e9d --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-scan.html @@ -0,0 +1,99 @@ +--- +title: fcli-sc-sast-scan(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-scan(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast scan [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
cancel
+
+

Cancel a previously submitted scan request.

+
+
start
+
+

Start a SAST scan.

+
+
status
+
+

Get status for a previously submitted scan request.

+
+
wait-for
+
+

Wait for one or more scans to reach or exit specified scan statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-sensor-list.html b/v2.10.1/manpage/fcli-sc-sast-sensor-list.html new file mode 100644 index 000000000..9828eccf5 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-sensor-list.html @@ -0,0 +1,141 @@ +--- +title: fcli-sc-sast-sensor-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-sensor-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast sensor list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

This command lists sensor information for all available SanCentral SAST sensors. It calls the SSC API and as such requires an active SSC session.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-sensor-pool-list.html b/v2.10.1/manpage/fcli-sc-sast-sensor-pool-list.html new file mode 100644 index 000000000..24ded910d --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-sensor-pool-list.html @@ -0,0 +1,140 @@ +--- +title: fcli-sc-sast-sensor-pool-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-sensor-pool-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast sensor-pool list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-sensor-pool.html b/v2.10.1/manpage/fcli-sc-sast-sensor-pool.html new file mode 100644 index 000000000..e079d5ce7 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-sensor-pool.html @@ -0,0 +1,87 @@ +--- +title: fcli-sc-sast-sensor-pool(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-sensor-pool(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast sensor-pool [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List ScanCentral SAST sensor pools.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-sensor.html b/v2.10.1/manpage/fcli-sc-sast-sensor.html new file mode 100644 index 000000000..b5e802a77 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-sensor.html @@ -0,0 +1,87 @@ +--- +title: fcli-sc-sast-sensor(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-sensor(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast sensor [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List ScanCentral SAST sensors.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-session-list.html b/v2.10.1/manpage/fcli-sc-sast-session-list.html new file mode 100644 index 000000000..6dfba3850 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-session-list.html @@ -0,0 +1,133 @@ +--- +title: fcli-sc-sast-session-list(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-session-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast session list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

This commands lists all ScanCentral SAST sessions created through the login command, as long as they haven’t been explicitly terminated through the 'logout' command.

+
+
+

For sessions created using user name and password, the output of this command will show session expiry date and status, based on the data provided by SSC at the time the login command was issued. Any changes to the generated token will not be reflected in the output of this command. Even if a session is no longer valid because the generated token was revoked (through SSC UI or 'fcli ssc access-control revoke-token' command), the output of this command may still show the session as not having expired. Similarly, any changes to token validity will not be reflected in the output of this command.

+
+
+

For sessions created using a pre-generated token, fcli cannot display session expiration date or status, as SSC doesn’t allow for obtaining this information.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-session-login.html b/v2.10.1/manpage/fcli-sc-sast-session-login.html new file mode 100644 index 000000000..cd9ce17f2 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-session-login.html @@ -0,0 +1,246 @@ +--- +title: fcli-sc-sast-session-login(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-session-login(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast session login -c[=<clientAuthToken>] [--session=<sessionName>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] ([-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --ssc-url=<sscUrl> [--ctrl-url=<controllerUrl>]) + ((-u=<user> -p[=<password>] + [--expire-in=<expireIn>]) | -t[=<token>])

+
+
+
+
+

Description

+
+
+

This command stores the SSC and ScanCentral SAST API URL and authentication token in an encrypted session file in the fcli state data folder, for use by other 'fcli sc-sast' commands to connect to the specified SSC/ScanCentral SAST instance. Option values may be passed on the command line or specified through environment variables (common for CI/CD pipeline use) as listed below.

+
+
+

When logging in with username and password, this command will connect to SSC to generate a CIToken; the user password is not stored by fcli. When logging in with a pre-generated CIToken, this token will be stored as-is after checking its validity. Note that on SSC 23.2 or below, fcli cannot determine when a pre-generated token will expire.

+
+
+

For interactive use, you may choose to keep the session open until it expires. For CI/CD integrations and other automations, you should always issue a logout command once work is complete. On shared/non-containerized systems, consider setting FCLI_STATE_DIR or FCLI_DATA_DIR environment variables to prevent unexpected interactions between different pipelines.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name for this ScanCentral SAST session. Default value: default.

+
+
-u, --ssc-user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_USER: Only SC SAST commands
+
+
+
+
-p, --ssc-password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_PASSWORD: Only SC SAST commands
+
+
+
+
--expire-in=<expireIn>
+
+

Specify for how long the session should remain active, for example 1h (1 hour) or 1d (1 day).

+
+
+
Default: 1d
+
+
+
+
-t, --ssc-ci-token[=<token>]
+
+

SSC CIToken in either encoded (REST) or decoded (application) format.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_CI_TOKEN: Only SC SAST commands
+
+
+
+
-c, --client-auth-token[=<clientAuthToken>]
+
+

ScanCentral SAST client_auth_token (shared secret).

+
+

This token must match the client_auth_token property in ScanCentral SAST

+
+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SC_SAST_CLIENT_AUTH_TOKEN
+
+
+
+
--ssc-url=<sscUrl>
+
+

SSC URL.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_URL: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_URL: Only SC SAST commands
+
+
+
+
--ctrl-url=<controllerUrl>
+
+

Override ScanCentral SAST Controller URL. If not specified, the controller URL as configured in SSC will be used.

+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 60 seconds.

+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-session-logout.html b/v2.10.1/manpage/fcli-sc-sast-session-logout.html new file mode 100644 index 000000000..6b424181b --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-session-logout.html @@ -0,0 +1,175 @@ +--- +title: fcli-sc-sast-session-logout(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-session-logout(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast session logout [--no-revoke-token] [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=<user> -p + [=<password>]]

+
+
+
+
+

Description

+
+
+

This command terminates a ScanCentral SAST session previously created through the 'login' command.

+
+
+

If the session was created with user credentials, this command will revoke the automatically generated SSC token unless the --no-revoke-token option is specified. On SSC 24.2 or above, the automatically generated token can be revoked without providing user credentials. For SSC 23.2 or below, user credentials are required to revoke the automatically generated token; the logout command will throw an error if neither user credentials nor --no-revoke-token option is specified, and the session will not be terminated.

+
+
+

If the session was created with a pre-generated token, the session will always be terminated without revoking the pre-generated token. As such, no user credentials need to be provided, and the --no-revoke-token option will have no effect.

+
+
+

To summarize: No user credentials nor --no-revoke-token option should be specified if the session was created with a pre-generated SSC token or if the session is connected to SSC 24.2 or above. Either user credentials or --no-revoke-token option must be specified if the session was created with user credentials AND the session is connected to SSC 23.2 or below.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name of the ScanCentral SAST session to be terminated. Default value: default.

+
+
-u, --ssc-user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_USER: Only SC SAST commands
+
+
+
+
-p, --ssc-password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SSC/SC DAST
+
+
+
+
+
FCLI_DEFAULT_SC_SAST_SSC_PASSWORD: Only SC SAST commands
+
+
+
+
--no-revoke-token
+
+

It is highly recommended to have fcli revoke the token that was automatically generated if the session was created using user credentials to avoid exceeding SSCs maximum token limit. This option is provided for convenience only, to allow the session to be terminated without having to specify user credentials on SSC 23.2 or below. Once most users have upgraded to SSC 24.2 or above, this option will be deprecated or removed.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast-session.html b/v2.10.1/manpage/fcli-sc-sast-session.html new file mode 100644 index 000000000..f11bef5bc --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast-session.html @@ -0,0 +1,97 @@ +--- +title: fcli-sc-sast-session(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast-session(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast session [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The session commands allow for managing one or more ScanCentral SAST sessions used to connect to a particular SSC/ScanCentral SAST environment with particular credentials. Potentially you can have multiple open ScanCentral SAST sessions, for example connecting to different SSC/ScanCentral SAST environments like DEV and PROD, or connecting to the same SSC/ScanCentral SAST instance but with different credentials.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List active and expired ScanCentral SAST sessions.

+
+
login
+
+

Create a session for interacting with ScanCentral SAST.

+
+
logout
+
+

Terminate ScanCentral SAST session.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-sc-sast.html b/v2.10.1/manpage/fcli-sc-sast.html new file mode 100644 index 000000000..de7656af9 --- /dev/null +++ b/v2.10.1/manpage/fcli-sc-sast.html @@ -0,0 +1,103 @@ +--- +title: fcli-sc-sast(1) +fcli_version: +--- + + + + + + + +fcli-sc-sast(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli sc-sast [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
session
+
+

Manage ScanCentral SAST sessions (start here).

+
+
scan
+
+

Manage ScanCentral SAST scans.

+
+
sensor
+
+

Manage ScanCentral SAST sensors.

+
+
sensor-pool, pool
+
+

Manage ScanCentral SAST sensor pools.

+
+
rest
+
+

Interact with ScanCentral SAST Controller REST API endpoints.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-create-local-user.html b/v2.10.1/manpage/fcli-ssc-access-control-create-local-user.html new file mode 100644 index 000000000..3df7fcec0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-create-local-user.html @@ -0,0 +1,185 @@ +--- +title: fcli-ssc-access-control-create-local-user(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-create-local-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control create-local-user [--pne] [--rpc] [--suspend] +[--email=<email>] [--firstname=<firstName>] [--lastname=<lastName>] +--password=<password> --username=<username> [--roles=<roles>[,<roles>…​]]…​ +[[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] +[--log-level=<logLevel>]] [[--session=<sessionName>]] ] +[--store=_variableName[:<propertyNames>]] [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--email=<email>
+
+

The email of the user

+
+
--firstname=<firstName>
+
+

The first name of the user

+
+
--lastname=<lastName>
+
+

The last name of the user

+
+
--password=<password>
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--pne, --password-never-expires
+
+

Causes the password of the user not to expire

+
+
--roles=<roles>[,<roles>…​]
+
+

Role name or id.

+
+
--rpc, --require-password-change
+
+

Requires the password of the user to be changed

+
+
--suspend
+
+

Causes the user to automatically be su

+
+
--username=<username>
+
+

The username of the user

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-create-role.html b/v2.10.1/manpage/fcli-ssc-access-control-create-role.html new file mode 100644 index 000000000..ca80a9aac --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-create-role.html @@ -0,0 +1,166 @@ +--- +title: fcli-ssc-access-control-create-role(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-create-role(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control create-role [--universal-access] [-d=<description>] + [-p=<permissionIds>[, + <permissionIds>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <name>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --description=<description>
+
+

Role description.

+
+
-p, --permission-ids=<permissionIds>[,<permissionIds>…​]
+
+

Comma-separated list of permission id’s to assign to this role.

+
+
--universal-access
+
+

Set this role to have universal access to all SSC application versions.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<name>
+
+

Role name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-create-token.html b/v2.10.1/manpage/fcli-ssc-access-control-create-token.html new file mode 100644 index 000000000..2d4425b73 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-create-token.html @@ -0,0 +1,206 @@ +--- +title: fcli-ssc-access-control-create-token(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-create-token(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control create-token -p[=<password>] + [--description=<description>] + [--expire-in=<expireIn>] -u=<user> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>] | [[-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --url=<url>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <type>

+
+
+
+
+

Description

+
+
+

This command can be used either with an existing SSC session (re-using SSC URL and other SSC connection settings), or without an existing session (in which case you’ll need to provide the SSC URL and any other relevant connection settings). SSC always requires user name and password to be specified for token operations, hence you’ll need to provide these even if you already established an SSC session.

+
+
+
+
+

Options

+
+
+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
--description=<description>
+
+

Token description.

+
+
--expire-in=<expireIn>
+
+

Expire token after the given time period, which is specified as 30m (30 minutes), 2h (2 hours), 1d (1 day).

+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
--url=<url>
+
+

Base URL for accessing the remote system.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<type>
+
+

Token type, like CIToken, AnalysisUploadToken, …​

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-delete-role.html b/v2.10.1/manpage/fcli-ssc-access-control-delete-role.html new file mode 100644 index 000000000..a3620abf2 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-delete-role.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-access-control-delete-role(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-delete-role(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control delete-role [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <roleNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<roleNameOrId>
+
+

Role name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-delete-user.html b/v2.10.1/manpage/fcli-ssc-access-control-delete-user.html new file mode 100644 index 000000000..f923fdf9b --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-delete-user.html @@ -0,0 +1,156 @@ +--- +title: fcli-ssc-access-control-delete-user(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-delete-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control delete-user [--allow-multi-match] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <authEntitySpecs>…​

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--allow-multi-match
+
+

Allow for multiple matches.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<authEntitySpecs>…​
+
+

One or more users or LDAP groups to remove; accepts comma-separated list of user id’s, entity names or email addresses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-get-permission.html b/v2.10.1/manpage/fcli-ssc-access-control-get-permission.html new file mode 100644 index 000000000..401631125 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-get-permission.html @@ -0,0 +1,142 @@ +--- +title: fcli-ssc-access-control-get-permission(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-get-permission(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control get-permission [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] + <permissionNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<permissionNameOrId>
+
+

Permission name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-get-role.html b/v2.10.1/manpage/fcli-ssc-access-control-get-role.html new file mode 100644 index 000000000..e22f18b90 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-get-role.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-access-control-get-role(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-get-role(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control get-role [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <roleNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<roleNameOrId>
+
+

Role name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-get-user.html b/v2.10.1/manpage/fcli-ssc-access-control-get-user.html new file mode 100644 index 000000000..efe4b9a35 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-get-user.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-access-control-get-user(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-get-user(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control get-user [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <authEntitySpec>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<authEntitySpec>
+
+

User or LDAP group, accepting user id, entity name, or email address.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-appversion-users.html b/v2.10.1/manpage/fcli-ssc-access-control-list-appversion-users.html new file mode 100644 index 000000000..0cfabb90f --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-appversion-users.html @@ -0,0 +1,147 @@ +--- +title: fcli-ssc-access-control-list-appversion-users(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-appversion-users(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-appversion-users --av=<appVersionNameOrId> +[--delim=<delimiter>] [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] +[--log-level=<logLevel>]] [[--session=<sessionName>]] ] +[--store=_variableName[:<propertyNames>]] [--to-file=<outputFile>]] [-q=<SpEL _ +_expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-permissions.html b/v2.10.1/manpage/fcli-ssc-access-control-list-permissions.html new file mode 100644 index 000000000..edeac53b9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-permissions.html @@ -0,0 +1,142 @@ +--- +title: fcli-ssc-access-control-list-permissions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-permissions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-permissions [--role=<roleNameOrId>] [[-h] +[--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] +[[--session=<sessionName>]] ] [--store=_variableName[: +<propertyNames>]] [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--role=<roleNameOrId>
+
+

Role name or id.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-roles.html b/v2.10.1/manpage/fcli-ssc-access-control-list-roles.html new file mode 100644 index 000000000..9bc37c47b --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-roles.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-access-control-list-roles(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-roles(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-roles [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-token-definitions.html b/v2.10.1/manpage/fcli-ssc-access-control-list-token-definitions.html new file mode 100644 index 000000000..d0a3a1430 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-token-definitions.html @@ -0,0 +1,142 @@ +--- +title: fcli-ssc-access-control-list-token-definitions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-token-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-token-definitions [--q-param=<qParam>] [[-h] +[--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] +[[--session=<sessionName>]] ] [--store=_variableName[: +<propertyNames>]] [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-tokens.html b/v2.10.1/manpage/fcli-ssc-access-control-list-tokens.html new file mode 100644 index 000000000..4f4157126 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-tokens.html @@ -0,0 +1,187 @@ +--- +title: fcli-ssc-access-control-list-tokens(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-tokens(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-tokens -p[=<password>] -u=<user> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>] | [[-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --url=<url>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

This command can be used either with an existing SSC session (re-using SSC URL and other SSC connection settings), or without an existing session (in which case you’ll need to provide the SSC URL and any other relevant connection settings). SSC always requires user name and password to be specified for token operations, hence you’ll need to provide these even if you already established an SSC session.

+
+
+
+
+

Options

+
+
+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
--url=<url>
+
+

Base URL for accessing the remote system.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-list-users.html b/v2.10.1/manpage/fcli-ssc-access-control-list-users.html new file mode 100644 index 000000000..b9ccb5464 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-list-users.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-access-control-list-users(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-list-users(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control list-users [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-revoke-token.html b/v2.10.1/manpage/fcli-ssc-access-control-revoke-token.html new file mode 100644 index 000000000..524c3905d --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-revoke-token.html @@ -0,0 +1,197 @@ +--- +title: fcli-ssc-access-control-revoke-token(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-revoke-token(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control revoke-token -p[=<password>] -u=<user> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>] | [[-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --url=<url>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] + <tokenIdsOrValues>…​

+
+
+
+
+

Description

+
+
+

This command can be used either with an existing SSC session (re-using SSC URL and other SSC connection settings), or without an existing session (in which case you’ll need to provide the SSC URL and any other relevant connection settings). SSC always requires user name and password to be specified for token operations, hence you’ll need to provide these even if you already established an SSC session.

+
+
+
+
+

Options

+
+
+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
--url=<url>
+
+

Base URL for accessing the remote system.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<tokenIdsOrValues>…​
+
+

Either one or more token id’s, or one or more token values (comma-separated)

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control-update-token.html b/v2.10.1/manpage/fcli-ssc-access-control-update-token.html new file mode 100644 index 000000000..deeb4aec1 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control-update-token.html @@ -0,0 +1,206 @@ +--- +title: fcli-ssc-access-control-update-token(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control-update-token(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control update-token -p[=<password>] + [--description=<description>] + [--expire-in=<expireIn>] -u=<user> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>] | [[-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] + --url=<url>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] token-id

+
+
+
+
+

Description

+
+
+

This command can be used either with an existing SSC session (re-using SSC URL and other SSC connection settings), or without an existing session (in which case you’ll need to provide the SSC URL and any other relevant connection settings). SSC always requires user name and password to be specified for token operations, hence you’ll need to provide these even if you already established an SSC session.

+
+
+
+
+

Options

+
+
+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
--description=<description>
+
+

Update token description.

+
+
--expire-in=<expireIn>
+
+

Update token expiration period, specified as 30m (30 minutes), 2h (2 hours), 1d (1 day).

+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this command, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
--url=<url>
+
+

Base URL for accessing the remote system.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
token-id
+
+

Token id as shown by token create and list commands. Note that this command does not accept the actual token value.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-access-control.html b/v2.10.1/manpage/fcli-ssc-access-control.html new file mode 100644 index 000000000..df7657032 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-access-control.html @@ -0,0 +1,147 @@ +--- +title: fcli-ssc-access-control(1) +fcli_version: +--- + + + + + + + +fcli-ssc-access-control(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc access-control [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list-token-definitions, lstd
+
+

List token definitions.

+
+
create-token
+
+

Create a token.

+
+
list-tokens, lst
+
+

List tokens.

+
+
revoke-token
+
+

Revoke a token.

+
+
update-token
+
+

Update a token.

+
+
create-role
+
+

Create a role.

+
+
delete-role, rm-role
+
+

Delete a role.

+
+
get-role
+
+

Get role details.

+
+
list-roles, lsr
+
+

List roles.

+
+
get-permission
+
+

Get permission details.

+
+
list-permissions, lsp
+
+

List permissions.

+
+
create-local-user
+
+

Create a local SSC User

+
+
delete-user, rm-user
+
+

Delete a user.

+
+
get-user
+
+

Get user details.

+
+
list-users, lsu
+
+

List users.

+
+
list-appversion-users, lsavu
+
+

List users assigned to an application version.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-get.html b/v2.10.1/manpage/fcli-ssc-action-get.html new file mode 100644 index 000000000..6dffb619e --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-get.html @@ -0,0 +1,149 @@ +--- +title: fcli-ssc-action-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action get [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>

+
+
+
+
+

Description

+
+
+

This command allows for listing the YAML contents of built-in or custom actions. This allows for reviewing the operations performed by an action, or for using the action contents as a basis for developing custom actions.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-help.html b/v2.10.1/manpage/fcli-ssc-action-help.html new file mode 100644 index 000000000..21e4dfc1c --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-help.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-action-help(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-help(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action help [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] <action>

+
+
+
+
+

Description

+
+
+

This command allows for showing the help information for the given built-in or custom action. The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-import.html b/v2.10.1/manpage/fcli-ssc-action-import.html new file mode 100644 index 000000000..81cfc6e91 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-import.html @@ -0,0 +1,192 @@ +--- +title: fcli-ssc-action-import(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-import(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action import [--on-invalid-signature=<onInvalidSignature>] + [--on-invalid-version=<onUnsupportedVersion>] + [--on-no-public-key=<onNoPublicKey>] + [--on-unsigned=<onUnsigned>] [--pubkey=source] + [-z=<source>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [<action>]

+
+
+
+
+

Description

+
+
+

Import one or more custom actions. You can import either a single action YAML file, or a zip-file containing one or more action YAML files. Imported actions will take precedence over built-in action if they have the same name.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location. If only --from-zip is specified, all actions from that zip-file will be imported.

+
+
+
+
+

Options

+
+
+
+
--on-invalid-signature=<onInvalidSignature>
+
+

Action to take if action signature is invalid. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-invalid-version=<onUnsupportedVersion>
+
+

Action to take if action schema version is not supported by this fcli version. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-no-public-key=<onNoPublicKey>
+
+

Action to take if no matching public key was found. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-unsigned=<onUnsigned>
+
+

Action to take if action isn’t signed. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
[<action>]
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-list.html b/v2.10.1/manpage/fcli-ssc-action-list.html new file mode 100644 index 000000000..c02aef278 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-list.html @@ -0,0 +1,131 @@ +--- +title: fcli-ssc-action-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action list [-z=<source>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

By default, this command lists available built-in and previously imported custom actions. If the --from-zip option is specified, this command lists available actions from the given local or remote zip file instead.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-reset.html b/v2.10.1/manpage/fcli-ssc-action-reset.html new file mode 100644 index 000000000..407eadaee --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-reset.html @@ -0,0 +1,112 @@ +--- +title: fcli-ssc-action-reset(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-reset(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action reset [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

Remove all previously imported custom actions, restoring fcli configuration to provide the default built-in actions only.

+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-run.html b/v2.10.1/manpage/fcli-ssc-action-run.html new file mode 100644 index 000000000..c6e7ea16b --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-run.html @@ -0,0 +1,193 @@ +--- +title: fcli-ssc-action-run(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-run(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action run [action-parameters]…​ + [--on-invalid-signature=<onInvalidSignature>] + [--on-invalid-version=<onUnsupportedVersion>] + [--on-no-public-key=<onNoPublicKey>] + [--on-unsigned=<onUnsigned>] [--progress=<type>] + [--pubkey=source] [-z=<source>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + <action>

+
+
+
+
+

Description

+
+
+

This command allows for running built-in or custom actions. As actions may perform potentially dangerous operations like deleting data or posting data to 3rd-party systems, you should only run trusted actions. For this reason, fcli requires confirmation when attempting to run an action without a (valid) signature.

+
+
+

The action can be specified as either a simple name or a local or remote action YAML file location. If specified as a simple name, the action will be loaded from the list of built-in and imported custom actions unless the --from-zip option is specified, in which case the action will be loaded from the given local or remote zip file. The --from-zip option will only be used if action is specified as a simple name, it will be ignored if the action is specified as a local or remote action YAML file location.

+
+
+
+
+

Options

+
+
+
+
action-parameters
+
+

Action parameter(s); see 'help' command output to list supported parameters.

+
+
--on-invalid-signature=<onInvalidSignature>
+
+

Action to take if action signature is invalid. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-invalid-version=<onUnsupportedVersion>
+
+

Action to take if action schema version is not supported by this fcli version. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-no-public-key=<onNoPublicKey>
+
+

Action to take if no matching public key was found. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--on-unsigned=<onUnsigned>
+
+

Action to take if action isn’t signed. Allowed values: ignore, warn, fail, prompt. Default value: prompt.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
--pubkey=source
+
+

Optional public key to use for verifying action signature. Can be specified as one of:

+
+
+
file:<local file>
+
+
+
+
+
url:<url>
+
+
+
+
+
string:<string value>
+
+
+
+
+
env:<env-var name>
+
+
+
+
+
If no prefix is given, <local file> is assumed. For security reasons, you should only use trusted public keys from a trusted source. Independent of source, contents must be in PEM (base64-encoded) format. For convenience with string: or env: inputs, the 'BEGIN/END PUBLIC KEY' statements and any whitespace (including newline characters) may be omitted, allowing for having a single-line string:<base64 public key contents> for example. Note that the given public key will be ignored if its fingerprint doesn't match the public key fingerprint stored in the action signature. If no (matching) public key is provided, action signature will be verified against public keys previously imported through the 'fcli config public-key import' command.
+
+
+
+
-z, --from-zip=<source>
+
+

Optional local or remote zip-file from which to load the action if the action is specified as a simple name. For commands that take an action as input (like get, help or run), this option will be ignored if action is specified as local or remote action YAML file location.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<action>
+
+

The action to load; either simple name or local or remote action YAML file location. Note that custom actions are currently considered PREVIEW functionality, as explained in the 'fcli ssc action -h' help output.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action-sign.html b/v2.10.1/manpage/fcli-ssc-action-sign.html new file mode 100644 index 000000000..a688505e2 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action-sign.html @@ -0,0 +1,167 @@ +--- +title: fcli-ssc-action-sign(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action-sign(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action sign [-y] [-p[=<privateKeyPassword>]] --in=<actionFileToSign> + [--info=<extraInfoPath>] --out=<signedActionFile> + [--pubout=<publicKeyPath>] [--signer=<signer>] + --with=<privateKeyPath> [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command allows for signing custom actions, allowing those actions to be run without confirmation if the corresponding public key has been imported through the fcli config public-key import command or passed in the --pubkey option on various action commands. The action to be signed must be a local file.

+
+
+

This command can use an existing private key for signing, or generate a new key pair if the private key file as specified through the --with option doesn’t yet exist and --pubout is specified to output the corresponding public key.

+
+
+

Private keys may also be generated using OpenSSL or similar tools, but note that only RSA keys in PEM format are supported, and only a small set of encryption schemes are supported for encrypted private keys. It is recommended to use AES encryption, which is supported by both native fcli executables and the .jar version of fcli. The latter requires Java 19 or above though to handle AES-encrypted private keys. Following is a sample OpenSSL command for generating an encrypted private key that’s supported by fcli for signing: + openssl genpkey -algorithm rsa -out private-key.pem -aes256

+
+
+

For convenience, when using a pre-existing private key, the --pubout option allows for outputting the corresponding public key for use by the fcli config public-key import command. Note that public keys will not be automatically added to the fcli trusted public key store; even if this command generates a key pair on the fly, you’ll still need to import the generated public key using the fcli config public-key import command.

+
+
+
+
+

Options

+
+
+
+
--in=<actionFileToSign>
+
+

Action YAML file to sign.

+
+
--info=<extraInfoPath>
+
+

YAML file containing informational properties to be added to signature metadata. For example, this can be used to document where the public key can be retrieved from, or some extra information about the action being signed.

+
+
--out=<signedActionFile>
+
+

Signed action output file.

+
+
-p, --password[=<privateKeyPassword>]
+
+

Private key password.

+
+
--pubout=<publicKeyPath>
+
+

Public key output file. This option is required when generating a new key pair (if given private key doesn’t exist), and may optionally be used for outputting the public key if an already existing private key is being used.

+
+
--signer=<signer>
+
+

Free-format text string describing who signed this action, for example a person, team or organization name. If not specified, signer will be taken from a property named 'signer' in the file specified with the --info option if available, otherwise the current user name will be used as the signer.

+
+
--with=<privateKeyPath>
+
+

PEM file containing private key used for signing.

+
+
-y, --confirm
+
+

Confirm overwriting existing output file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-action.html b/v2.10.1/manpage/fcli-ssc-action.html new file mode 100644 index 000000000..a9a6deba6 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-action.html @@ -0,0 +1,122 @@ +--- +title: fcli-ssc-action(1) +fcli_version: +--- + + + + + + + +fcli-ssc-action(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc action [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

Fcli supports workflow-style actions defined in YAML files. Many built-in actions are provided, focusing on data export and CI/CD integration. Users can also develop their own custom actions, either from scratch or by customizing built-in actions. If you require any assistance with developing custom actions, please consult with Fortify Professional Services.

+
+
+

Note that the ability to load and run custom actions is currently considered PREVIEW functionality; custom actions developed for this fcli version may fail on other fcli versions, even between minor fcli releases. Based on user feedback, we will stabilize action syntax over the next couple of fcli releases, after which any breaking action syntax changes will be considered a major fcli version change.

+
+
+

This fcli version supports the following action schema versions: See fcli help output.

+
+
+

Actions can potentially perform dangerous operations like deleting data or posting data to 3rd-party systems, so it is recommended to only run trusted actions. Action authors can sign their actions using the action sign command; actions without a (valid) signature will require confirmation when trying to run them. Trusted public keys can be configured through the fcli config public-key commands, or passed directly using the --pubkey option on various action-related commands.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get
+
+

Get action contents.

+
+
help
+
+

Show action usage help.

+
+
import
+
+

Import custom actions.

+
+
list, ls
+
+

List built-in and imported actions.

+
+
reset
+
+

Remove all custom actions.

+
+
run
+
+

Run an action.

+
+
sign
+
+

Sign action.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-alert-get-definition.html b/v2.10.1/manpage/fcli-ssc-alert-get-definition.html new file mode 100644 index 000000000..1001981a8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-alert-get-definition.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-alert-get-definition(1) +fcli_version: +--- + + + + + + + +fcli-ssc-alert-get-definition(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc alert get-definition [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <alertDefinitionId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<alertDefinitionId>
+
+

Alert definition id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-alert-list-definitions.html b/v2.10.1/manpage/fcli-ssc-alert-list-definitions.html new file mode 100644 index 000000000..cd71ca2cc --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-alert-list-definitions.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-alert-list-definitions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-alert-list-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc alert list-definitions [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-alert-list.html b/v2.10.1/manpage/fcli-ssc-alert-list.html new file mode 100644 index 000000000..5a01d92dd --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-alert-list.html @@ -0,0 +1,143 @@ +--- +title: fcli-ssc-alert-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-alert-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc alert list [--q-param=<qParam>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-alert.html b/v2.10.1/manpage/fcli-ssc-alert.html new file mode 100644 index 000000000..3ecb368cc --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-alert.html @@ -0,0 +1,95 @@ +--- +title: fcli-ssc-alert(1) +fcli_version: +--- + + + + + + + +fcli-ssc-alert(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc alert [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get-definition
+
+

Get alert definition details.

+
+
list-definitions, lsd
+
+

List alert definitions.

+
+
list, ls
+
+

List alerts.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-app-delete.html b/v2.10.1/manpage/fcli-ssc-app-delete.html new file mode 100644 index 000000000..7e925cb81 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-app-delete.html @@ -0,0 +1,153 @@ +--- +title: fcli-ssc-app-delete(1) +fcli_version: +--- + + + + + + + +fcli-ssc-app-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc app delete [-y] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <appNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-y, --confirm
+
+

Confirm deletion of all versions within the specified application.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application name or id. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-app-get.html b/v2.10.1/manpage/fcli-ssc-app-get.html new file mode 100644 index 000000000..32da6a395 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-app-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-ssc-app-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-app-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc app get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <appNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application name or id. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-app-list.html b/v2.10.1/manpage/fcli-ssc-app-list.html new file mode 100644 index 000000000..fb7db7833 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-app-list.html @@ -0,0 +1,143 @@ +--- +title: fcli-ssc-app-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-app-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc app list [--q-param=<qParam>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-app-update.html b/v2.10.1/manpage/fcli-ssc-app-update.html new file mode 100644 index 000000000..802f893c5 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-app-update.html @@ -0,0 +1,157 @@ +--- +title: fcli-ssc-app-update(1) +fcli_version: +--- + + + + + + + +fcli-ssc-app-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc app update [-d=<description>] [-n=<name>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <appNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --description=<description>
+
+

New description for the application.

+
+
-n, --name=<name>
+
+

New name for the application.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appNameOrId>
+
+

Application name or id. Note that numeric values are always interpreted as id’s. If you have numeric application names, you will need to specify the application id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-app.html b/v2.10.1/manpage/fcli-ssc-app.html new file mode 100644 index 000000000..2b3a8dcdc --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-app.html @@ -0,0 +1,99 @@ +--- +title: fcli-ssc-app(1) +fcli_version: +--- + + + + + + + +fcli-ssc-app(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc app [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
delete, rm
+
+

Delete an application and all contained versions.

+
+
get
+
+

Get application details.

+
+
list, ls
+
+

List applications.

+
+
update
+
+

Update an application.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-copy-state.html b/v2.10.1/manpage/fcli-ssc-appversion-copy-state.html new file mode 100644 index 000000000..8df553762 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-copy-state.html @@ -0,0 +1,168 @@ +--- +title: fcli-ssc-appversion-copy-state(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-copy-state(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion copy-state [--[no-]refresh] [--delim=<delimiter>] + --from=<fromAppVersionNameOrId> + [--refresh-timeout=<timeoutPeriod>] + --to=<toAppVersionNameOrId> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

Copy application version state from another application version. +Note that this command may potentially have unintended side effects when copying state to application versions that already contain artifacts.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--from, --copy-from=<fromAppVersionNameOrId>
+
+

Copy FROM application version:

+
+

id or <application>:<version> name.

+
+
+
--[no-]refresh
+
+

By default, this command will refresh the source application version’s metrics when copying from it. Note that for large applications this can lead to an error if the timeout expires.

+
+
--refresh-timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour). Default value: 60s

+
+
--to, --copy-to=<toAppVersionNameOrId>
+
+

Copy TO application version:

+
+

id or <application>:<version> name.

+
+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-create.html b/v2.10.1/manpage/fcli-ssc-appversion-create.html new file mode 100644 index 000000000..876a81d47 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-create.html @@ -0,0 +1,223 @@ +--- +title: fcli-ssc-appversion-create(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion create [--auto-required-attrs] [--[no-]refresh] + [--skip-if-exists] [--active=<active>] + [-d=<description>] [--delim=<delimiter>] + [--issue-template=<issueTemplateNameOrId>] + [--refresh-timeout=<timeoutPeriod>] + [--add-users=<authEntitySpecs>[, + <authEntitySpecs>…​]]…​ [--attrs=ATTR=VALUE[, + ATTR=VALUE…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] + [--from=<appVersionNameOrId> [--copy=<copyOptions>[, + <copyOptions>…​]]…​] <app>:<version>

+
+
+
+
+

Description

+
+
+

This command allows for creating a new SSC application version, optionally skipping creation if the application version already exists (see --skip-if-exists option), and/or copying configuration and state of an existing application version (see --copy and --copy-from options).

+
+
+

Note that depending on user and token permissions, SSC may reject some of the application version configuration settings. In particular, user access permissions as specified through the --add-users option or when copying an existing application version may not be applied if the fcli session was created using a CIToken.

+
+
+
+
+

Options

+
+
+
+
--active=<active>
+
+

Specify whether application version should be activated (true, default) or not (false).

+
+
--add-users=<authEntitySpecs>[,<authEntitySpecs>…​]
+
+

Assign one or more (comma-separated) users or LDAP groups to the application version; accepts user id, entity name or email address. Option is repeatable.

+
+
--attrs, --attributes=ATTR=VALUE[,ATTR=VALUE…​]
+
+

Example: ATTR1=[VAL1;VAL2],CATEGORY:ATTR2=VAL3

+
+

Set values for one or more attributes. This option accepts a comma-separated list of KEY=VALUE assignments.

+
+
+

Each KEY accepts either the Attribute’s GUID or its Name with the optional Category (InfoClassification or "BUSINESS:Data Classification" or "Data Classification")

+
+
+

Each VALUE accepts a semicolon-separated list of Attribute’s Values, encapsulated in brackets (optional for single value)

+
+
+
--auto-required-attrs
+
+

Automatically set a default value for required application version attributes.

+
+
--copy=<copyOptions>[,<copyOptions>…​]
+
+

Comma separated list of elements to copy (Requires --copy-from). By default, all are copied. Allowed values: custom-tags, bugtracker, BugTrackerConfiguration, processing-rules, AnalysisProcessingRules, attributes, users, state. The BugTrackerConfiguration and AnalysisProcessingRules values are deprecated and will be removed in a future fcli version.

+
+
-d, --description=<description>
+
+

Application version description.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--from, --copy-from=<appVersionNameOrId>
+
+

Copy FROM application version:

+
+

id or <application>:<version> name.

+
+
+
--issue-template=<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
--[no-]refresh
+
+

By default, this command will refresh the source application version’s metrics when copying from it. Note that for large applications this can lead to an error if the timeout expires.

+
+
--refresh-timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour). Default value: 60s

+
+
--skip-if-exists
+
+

Skip application version creation if an application version with the specified name already exists.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<app>:<version>
+
+

Application and version name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-delete.html b/v2.10.1/manpage/fcli-ssc-appversion-delete.html new file mode 100644 index 000000000..f9cbf9490 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-delete.html @@ -0,0 +1,154 @@ +--- +title: fcli-ssc-appversion-delete(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion delete [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <appVersionNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-download-state.html b/v2.10.1/manpage/fcli-ssc-appversion-download-state.html new file mode 100644 index 000000000..c34adebc4 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-download-state.html @@ -0,0 +1,167 @@ +--- +title: fcli-ssc-appversion-download-state(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-download-state(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion download-state [--[no-]include-sources] + [--delim=<delimiter>] [-f=<file>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <appVersionNameOrId>

+
+
+
+
+

Description

+
+
+

Download application version state artifact. See 'fcli ssc artifact download' for downloading individual artifacts.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-f, --file=<file>
+
+

Optional output file path.

+
+
--[no-]include-sources
+
+

Sources are included by default; use --no-include-sources to download artifact without sources.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-get.html b/v2.10.1/manpage/fcli-ssc-appversion-get.html new file mode 100644 index 000000000..dddb591a6 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-get.html @@ -0,0 +1,159 @@ +--- +title: fcli-ssc-appversion-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion get [--delim=<delimiter>] [--embed=<embedSuppliers>[, + <embedSuppliers>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <appVersionNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--embed=<embedSuppliers>[,<embedSuppliers>…​]
+
+

Embed extra application version data. Allowed values: attrs, attrValuesByName, attrValuesByGuid, bugtracker, customTags, filterSets, folders, resultProcessingRules.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-list.html b/v2.10.1/manpage/fcli-ssc-appversion-list.html new file mode 100644 index 000000000..e67833bb9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-list.html @@ -0,0 +1,181 @@ +--- +title: fcli-ssc-appversion-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion list [--q-param=<qParam>] [--embed=<embedSuppliers>[, + <embedSuppliers>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

By default, this command simply lists all application versions. However, the --embed, --query and --output options allow for implementing advanced use cases. Some examples:

+
+
+
+
List application versions created by user 'admin':
+-q 'createdBy=="admin"'
+
+
+
+
+
List application versions requiring refresh:
+-q 'refreshRequired'
+
+
+
+
+
List application versions with artifacts requiring approval:
+-q 'currentState.attentionRequired'
+
+
+
+
+
List application versions with business risk 'High':
+--embed attrValuesByGuid -q 'attrValuesByGuid["BusinessRisk"].contains("High")'
+
+
+
+
+
Generate script for purging all application versions:
+-o 'expr=fcli ssc appversion purge-artifacts --older-than 30d {id}\n'
+
+
+
+
+
+

Options

+
+
+
+
--embed=<embedSuppliers>[,<embedSuppliers>…​]
+
+

Embed extra application version data. Allowed values: attrs, attrValuesByName, attrValuesByGuid, bugtracker, customTags, filterSets, folders, resultProcessingRules.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-purge-artifacts.html b/v2.10.1/manpage/fcli-ssc-appversion-purge-artifacts.html new file mode 100644 index 000000000..c8f0d4450 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-purge-artifacts.html @@ -0,0 +1,162 @@ +--- +title: fcli-ssc-appversion-purge-artifacts(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-purge-artifacts(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion purge-artifacts [--delim=<delimiter>] [-p=<olderThan>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <appVersionNameOrId>

+
+
+
+
+

Description

+
+
+

Purge all application version artifacts older than the specified date. See 'fcli ssc artifact purge' for purging individual artifacts.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-p, --older-than=<olderThan>
+
+

Purge artifacts older than the specified value, in the format 30d (30 days), 1y (1 year).

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-refresh-metrics.html b/v2.10.1/manpage/fcli-ssc-appversion-refresh-metrics.html new file mode 100644 index 000000000..ad1bfefa0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-refresh-metrics.html @@ -0,0 +1,164 @@ +--- +title: fcli-ssc-appversion-refresh-metrics(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-refresh-metrics(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion refresh-metrics [--delim=<delimiter>] + [--embed=<embedSuppliers>[, + <embedSuppliers>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <appVersionNameOrId>

+
+
+
+
+

Description

+
+
+

This command allows for refreshing SSC application version metrics, similar to the little 'refresh' button shown on the SSC application version page in case a refresh is required/pending.

+
+
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--embed=<embedSuppliers>[,<embedSuppliers>…​]
+
+

Embed extra application version data. Allowed values: attrs, attrValuesByName, attrValuesByGuid, bugtracker, customTags, filterSets, folders, resultProcessingRules.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion-update.html b/v2.10.1/manpage/fcli-ssc-appversion-update.html new file mode 100644 index 000000000..008e26a4e --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion-update.html @@ -0,0 +1,202 @@ +--- +title: fcli-ssc-appversion-update(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion update [--active=<active>] [-d=<description>] + [--delim=<delimiter>] + [--issue-template=<issueTemplateNameOrId>] + [-n=<name>] [--add-users=<authEntitySpecs>[, + <authEntitySpecs>…​]]…​ [--attrs=ATTR=VALUE[, + ATTR=VALUE…​]]…​ [--rm-users=<authEntitySpecs>[, + <authEntitySpecs>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <appVersionNameOrId>

+
+
+
+
+

Description

+
+
+

This command allows for updating an existing SSC application version.

+
+
+

Note that depending on user and token permissions, SSC may reject some of the application version configuration settings. In particular, user access permissions as specified through the --add-users or --rm-users option may not be applied if the fcli session was created using a CIToken.

+
+
+
+
+

Options

+
+
+
+
--active=<active>
+
+

Specify whether application version should be activated (true) or not (false).

+
+
--add-users=<authEntitySpecs>[,<authEntitySpecs>…​]
+
+

Assign one or more (comma-separated) users or LDAP groups to the application version; accepts user id, entity name or email address. Option is repeatable.

+
+
--attrs, --attributes=ATTR=VALUE[,ATTR=VALUE…​]
+
+

Example: ATTR1=[VAL1;VAL2],CATEGORY:ATTR2=VAL3

+
+

Set values for one or more attributes. This option accepts a comma-separated list of KEY=VALUE assignments.

+
+
+

Each KEY accepts either the Attribute’s GUID or its Name with the optional Category (InfoClassification or "BUSINESS:Data Classification" or "Data Classification")

+
+
+

Each VALUE accepts a semicolon-separated list of Attribute’s Values, encapsulated in brackets (optional for single value)

+
+
+
-d, --description=<description>
+
+

Update application version description.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--issue-template=<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
-n, --name=<name>
+
+

Update application version name.

+
+
--rm-users=<authEntitySpecs>[,<authEntitySpecs>…​]
+
+

Remove one or more (comma-separated) users or LDAP groups from the application version; accepts user id, entity name or email address. Option is repeatable.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-appversion.html b/v2.10.1/manpage/fcli-ssc-appversion.html new file mode 100644 index 000000000..cf7ce5023 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-appversion.html @@ -0,0 +1,119 @@ +--- +title: fcli-ssc-appversion(1) +fcli_version: +--- + + + + + + + +fcli-ssc-appversion(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc appversion [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
create
+
+

Create an application version.

+
+
delete, rm
+
+

Delete an application version.

+
+
copy-state
+
+

(PREVIEW) Copy application version state.

+
+
download-state
+
+

Download application version state.

+
+
get
+
+

Get application version details.

+
+
list, ls
+
+

List application versions.

+
+
purge-artifacts
+
+

Purge application version artifacts.

+
+
refresh-metrics
+
+

Refresh application version metrics.

+
+
update
+
+

Update an application version.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-approve.html b/v2.10.1/manpage/fcli-ssc-artifact-approve.html new file mode 100644 index 000000000..96c9709b9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-approve.html @@ -0,0 +1,153 @@ +--- +title: fcli-ssc-artifact-approve(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-approve(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact approve [-m=<message>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] artifact-id

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-m, --message=<message>
+
+

Approval message, default value 'Approved through fcli'.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
artifact-id
+
+

Artifact id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-delete.html b/v2.10.1/manpage/fcli-ssc-artifact-delete.html new file mode 100644 index 000000000..e8d9da67c --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-delete.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-artifact-delete(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact delete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] artifact-id

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
artifact-id
+
+

Artifact id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-download.html b/v2.10.1/manpage/fcli-ssc-artifact-download.html new file mode 100644 index 000000000..eaccd75f8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-download.html @@ -0,0 +1,160 @@ +--- +title: fcli-ssc-artifact-download(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact download [--[no-]include-sources] [-f=<file>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] artifact-id

+
+
+
+
+

Description

+
+
+

Download an artifact by id. See 'fcli ssc appversion download-state' for downloading application state.

+
+
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Optional output file path.

+
+
--[no-]include-sources
+
+

Sources are included by default; use --no-include-sources to download artifact without sources.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
artifact-id
+
+

Artifact id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-get.html b/v2.10.1/manpage/fcli-ssc-artifact-get.html new file mode 100644 index 000000000..747cc0510 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-ssc-artifact-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <artifactId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<artifactId>
+
+

Id of the artifact to be retrieved.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-import-debricked.html b/v2.10.1/manpage/fcli-ssc-artifact-import-debricked.html new file mode 100644 index 000000000..7c367f370 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-import-debricked.html @@ -0,0 +1,196 @@ +--- +title: fcli-ssc-artifact-import-debricked(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-import-debricked(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact import-debricked --av=<appVersionNameOrId> -b=<branch> + [--delim=<delimiter>] [-e=<engineType>] + [-f=<fileName>] [--progress=<type>] + -r=<repository> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + ([-k] [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>]) + ((-u=<user> -p[=<password>]) | -t + [=<accessToken>])

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
-b, --branch=<branch>
+
+

Branch in the given repository for which to retrieve the SBOM.

+
+
--connect-timeout=<connectTimeout>
+
+

Debricked connection timeout, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-e, --engine-type=<engineType>
+
+

SSC engine type. Default value: DEBRICKED.

+
+
-f, --save-sbom-as=<fileName>
+
+

Save a copy of the SBOM file downloaded from Debricked to the given file.

+
+
-k, --insecure
+
+

Disable SSC checks when connecting to Debricked.

+
+
-p, --debricked-password[=<password>]
+
+

Password for the given debricked user.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-r, --repository=<repository>
+
+

Debricked repository name or id.

+
+
--socket-timeout=<socketTimeout>
+
+

Debricked socket timeout, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
-t, --debricked-access-token[=<accessToken>]
+
+

Debricked long-lived access token.

+
+
-u, --debricked-user=<user>
+
+

Debricked user name / email address.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-list.html b/v2.10.1/manpage/fcli-ssc-artifact-list.html new file mode 100644 index 000000000..5b376ca97 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-ssc-artifact-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact list --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-purge.html b/v2.10.1/manpage/fcli-ssc-artifact-purge.html new file mode 100644 index 000000000..a89ad11a9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-purge.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-artifact-purge(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-purge(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact purge [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] artifact-id

+
+
+
+
+

Description

+
+
+

Purge an individual artifact by id. See 'fcli ssc appversion purge-artifacts' for purging multiple artifacts by date.

+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
artifact-id
+
+

Artifact id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-upload.html b/v2.10.1/manpage/fcli-ssc-artifact-upload.html new file mode 100644 index 000000000..16be42589 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-upload.html @@ -0,0 +1,156 @@ +--- +title: fcli-ssc-artifact-upload(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-upload(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact upload --av=<appVersionNameOrId> [--delim=<delimiter>] + [-e=<engineType>] -f=<file> [--progress=<type>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-e, --engine-type=<engineType>
+
+

Engine type specifying which SSC parser plugin should be used to process the uploaded artifact. This option should only be used for raw 3rd-party results, not for standard Fortify (FPR) results or 3rd-party results in a zip-file accompanied by a scan.info file.

+
+
-f, --file=<file>
+
+

File to upload.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact-wait-for.html b/v2.10.1/manpage/fcli-ssc-artifact-wait-for.html new file mode 100644 index 000000000..19378d7ef --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact-wait-for.html @@ -0,0 +1,203 @@ +--- +title: fcli-ssc-artifact-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact wait-for [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequeste + _ d>_] [--progress=<type>] [-t=<timeoutPeriod>] + [-s=<states>[,<states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=any-match|all-match | + -w=any-match|all-match] [[--session=<sessionName>]] + artifact-id’s…​

+
+
+
+
+

Description

+
+
+

Although this command offers a lot of options to cover many different use cases, you can simply pass an artifact id (possibly stored using --store on the 'artifact upload' command) to wait for artifact processing completion. If any error state or unknown state is detected, an exception will be thrown.

+
+
+

The following states are currently known by fcli: +See fcli help output

+
+
+
+
+

Options

+
+
+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more processing states against which to match the given artifacts.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all artifacts match. If neither --until or --while are specified, default is to wait until all artifacts match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all artifacts match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
artifact-id’s…​
+
+

One or more artifact id’s.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-artifact.html b/v2.10.1/manpage/fcli-ssc-artifact.html new file mode 100644 index 000000000..829ed6968 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-artifact.html @@ -0,0 +1,119 @@ +--- +title: fcli-ssc-artifact(1) +fcli_version: +--- + + + + + + + +fcli-ssc-artifact(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc artifact [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
approve
+
+

Approve an artifact.

+
+
delete, rm
+
+

Delete an artifact.

+
+
download
+
+

Download an artifact.

+
+
get
+
+

Get artifact details.

+
+
import-debricked
+
+

Import results from Debricked as SSC application version artifact.

+
+
list, ls
+
+

List application version artifacts.

+
+
purge
+
+

Purge an artifact.

+
+
upload
+
+

Upload an artifact.

+
+
wait-for
+
+

Wait for SSC artifact to reach or exit specified artifact statuses.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-attribute-get-definition.html b/v2.10.1/manpage/fcli-ssc-attribute-get-definition.html new file mode 100644 index 000000000..23d77eab0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-attribute-get-definition.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-attribute-get-definition(1) +fcli_version: +--- + + + + + + + +fcli-ssc-attribute-get-definition(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc attribute get-definition [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [CATEGORY:]ATTR

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
[CATEGORY:]ATTR
+
+

Attribute definition name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-attribute-list-definitions.html b/v2.10.1/manpage/fcli-ssc-attribute-list-definitions.html new file mode 100644 index 000000000..0cf32d4b6 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-attribute-list-definitions.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-attribute-list-definitions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-attribute-list-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc attribute list-definitions [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-attribute-list.html b/v2.10.1/manpage/fcli-ssc-attribute-list.html new file mode 100644 index 000000000..b2b80c015 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-attribute-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-ssc-attribute-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-attribute-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc attribute list --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-attribute-update.html b/v2.10.1/manpage/fcli-ssc-attribute-update.html new file mode 100644 index 000000000..c5bc26e37 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-attribute-update.html @@ -0,0 +1,158 @@ +--- +title: fcli-ssc-attribute-update(1) +fcli_version: +--- + + + + + + + +fcli-ssc-attribute-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc attribute update --av=<appVersionNameOrId> [--delim=<delimiter>] + --attrs=ATTR=VALUE[,ATTR=VALUE…​] [--attrs=ATTR=VALUE + [,ATTR=VALUE…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--attrs, --attributes=ATTR=VALUE[,ATTR=VALUE…​]
+
+

Example: ATTR1=[VAL1;VAL2],CATEGORY:ATTR2=VAL3

+
+

Set values for one or more attributes. This option accepts a comma-separated list of KEY=VALUE assignments.

+
+
+

Each KEY accepts either the Attribute’s GUID or its Name with the optional Category (InfoClassification or "BUSINESS:Data Classification" or "Data Classification")

+
+
+

Each VALUE accepts a semicolon-separated list of Attribute’s Values, encapsulated in brackets (optional for single value)

+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-attribute.html b/v2.10.1/manpage/fcli-ssc-attribute.html new file mode 100644 index 000000000..fead7aa2d --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-attribute.html @@ -0,0 +1,99 @@ +--- +title: fcli-ssc-attribute(1) +fcli_version: +--- + + + + + + + +fcli-ssc-attribute(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc attribute [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
get-definition
+
+

Get attribute definition details.

+
+
list-definitions, lsd
+
+

List attribute definitions.

+
+
list, ls
+
+

List application version attributes.

+
+
update
+
+

Update application version attributes.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-count.html b/v2.10.1/manpage/fcli-ssc-issue-count.html new file mode 100644 index 000000000..a9a1785b5 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-count.html @@ -0,0 +1,162 @@ +--- +title: fcli-ssc-issue-count(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-count(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue count --av=<appVersionNameOrId> [--by=<groupSetDisplayNameOrId>] + [--delim=<delimiter>] [--filter=<filter>] + [--fs=<filterSetTitleOrId>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--by=<groupSetDisplayNameOrId>
+
+

Issue group display name or id.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--filter=<filter>
+
+

Filter issue counts using the given (friendly or technical) filter. See 'fcli ssc issue list-filters' for allowed values.

+
+
--fs, --filterset=<filterSetTitleOrId>
+
+

Filter set title (name) or id.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-create-template.html b/v2.10.1/manpage/fcli-ssc-issue-create-template.html new file mode 100644 index 000000000..766c484e1 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-create-template.html @@ -0,0 +1,153 @@ +--- +title: fcli-ssc-issue-create-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-create-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue create-template [--set-as-default] [-d=<description>] -f=<file> + -n=<issueTemplateName> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --description=<description>
+
+

Issue template description.

+
+
-f, --file=<file>
+
+

Issue template file path.

+
+
-n, --name=<issueTemplateName>
+
+

Issue template name.

+
+
--set-as-default
+
+

Set this issue template as the default issue template.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-delete-template.html b/v2.10.1/manpage/fcli-ssc-issue-delete-template.html new file mode 100644 index 000000000..f1616a516 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-delete-template.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-issue-delete-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-delete-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue delete-template [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <issueTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-download-template.html b/v2.10.1/manpage/fcli-ssc-issue-download-template.html new file mode 100644 index 000000000..655fa78d4 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-download-template.html @@ -0,0 +1,155 @@ +--- +title: fcli-ssc-issue-download-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-download-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue download-template [-f=<file>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <issueTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Optional issue template file path.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-get-filter.html b/v2.10.1/manpage/fcli-ssc-issue-get-filter.html new file mode 100644 index 000000000..c86065551 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-get-filter.html @@ -0,0 +1,157 @@ +--- +title: fcli-ssc-issue-get-filter(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-get-filter(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue get-filter --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <filter>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<filter>
+
+

Technical or friendly filter as returned by the 'fcli ssc issue list-filters' command.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-get-filterset.html b/v2.10.1/manpage/fcli-ssc-issue-get-filterset.html new file mode 100644 index 000000000..118d2e603 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-get-filterset.html @@ -0,0 +1,159 @@ +--- +title: fcli-ssc-issue-get-filterset(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-get-filterset(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue get-filterset --av=<appVersionNameOrId> [--delim=<delimiter>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <filterSetTitleOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<filterSetTitleOrId>
+
+

Filter set title (name) or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-get-group.html b/v2.10.1/manpage/fcli-ssc-issue-get-group.html new file mode 100644 index 000000000..61c65612f --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-get-group.html @@ -0,0 +1,158 @@ +--- +title: fcli-ssc-issue-get-group(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-get-group(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue get-group --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <groupSetDisplayNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<groupSetDisplayNameOrId>
+
+

Issue group display name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-get-template.html b/v2.10.1/manpage/fcli-ssc-issue-get-template.html new file mode 100644 index 000000000..9ac60a697 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-get-template.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-issue-get-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-get-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue get-template [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <issueTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-list-filters.html b/v2.10.1/manpage/fcli-ssc-issue-list-filters.html new file mode 100644 index 000000000..c56437f15 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-list-filters.html @@ -0,0 +1,149 @@ +--- +title: fcli-ssc-issue-list-filters(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-list-filters(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue list-filters --av=<appVersionNameOrId> [--delim=<delimiter>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-list-filtersets.html b/v2.10.1/manpage/fcli-ssc-issue-list-filtersets.html new file mode 100644 index 000000000..bd4e8a328 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-list-filtersets.html @@ -0,0 +1,149 @@ +--- +title: fcli-ssc-issue-list-filtersets(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-list-filtersets(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue list-filtersets --av=<appVersionNameOrId> [--delim=<delimiter>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-list-groups.html b/v2.10.1/manpage/fcli-ssc-issue-list-groups.html new file mode 100644 index 000000000..6dd01cfb4 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-list-groups.html @@ -0,0 +1,148 @@ +--- +title: fcli-ssc-issue-list-groups(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-list-groups(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue list-groups --av=<appVersionNameOrId> [--delim=<delimiter>] + [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-list-templates.html b/v2.10.1/manpage/fcli-ssc-issue-list-templates.html new file mode 100644 index 000000000..aec61a269 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-list-templates.html @@ -0,0 +1,145 @@ +--- +title: fcli-ssc-issue-list-templates(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-list-templates(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue list-templates [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-list.html b/v2.10.1/manpage/fcli-ssc-issue-list.html new file mode 100644 index 000000000..51edb68e0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-list.html @@ -0,0 +1,179 @@ +--- +title: fcli-ssc-issue-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue list --av=<appVersionNameOrId> [--delim=<delimiter>] + [--filter=<filter>] [--fs=<filterSetTitleOrId>] + [--q-param=<qParam>] [--embed=<embedSuppliers>[, + <embedSuppliers>…​]]…​ [-i=<status>[,<status>…​]]…​ + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

This command allows for listing SSC vulnerability data for a given application version. By default, only visible issues will be returned; the --include option can be used to (also) include hidden, suppressed or removed issues. If any such issues are included, the default table output will show (H), (S), and/or ® for respectively hidden, suppressed and removed issues.

+
+
+

Optionally, additional details may be included in the output using the --embed option, but please note that this may have some impact on performance as this will result in additional HTTP requests to SSC for every page of issues.

+
+
+

In general, performance of this command is largely dependent on the number of issues being retrieved from SSC. The default table output collects all data in memory until all issues have been processed, so it may take a long time before you see any output, and there’s a small risk of running out of memory. Most other output formats (like json, yaml, or csv) output data immediately after each page of issues has been loaded from FoD, resulting in more immediate output.

+
+
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
--embed=<embedSuppliers>[,<embedSuppliers>…​]
+
+

Embed extra application version data. Allowed values: details, comments, auditHistory. Using the --output option, this extra data can be included in the output. Using the --query option, this extra data can be queried upon. To get an understanding of the structure and contents of the embedded data, use the --output json or --output yaml options.

+
+
--filter=<filter>
+
+

Filter issues using the given (friendly or technical) filter. See 'fcli ssc issue list-filters' for allowed values.

+
+
--fs, --filterset=<filterSetTitleOrId>
+
+

Filter set title (name) or id.

+
+
-i, --include=<status>[,<status>…​]
+
+

By default, only visible issues will be returned. This option accepts a comma-separated list to allow (also) removed, suppressed and/or hidden issues to be returned, for example --include visible,removed (to return both visible and removed issues) or --include removed (to return only removed issues). Allowed values: visible, hidden, removed, suppressed.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue-update-template.html b/v2.10.1/manpage/fcli-ssc-issue-update-template.html new file mode 100644 index 000000000..89fcaa7cd --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue-update-template.html @@ -0,0 +1,163 @@ +--- +title: fcli-ssc-issue-update-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue-update-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue update-template [--set-as-default] [-d=<description>] + [-n=<name>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <issueTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --description=<description>
+
+

Update issue template description.

+
+
-n, --name=<name>
+
+

Update issue template name.

+
+
--set-as-default
+
+

Set this issue template as the default issue template.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<issueTemplateNameOrId>
+
+

Issue template name or id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-issue.html b/v2.10.1/manpage/fcli-ssc-issue.html new file mode 100644 index 000000000..7d3be599c --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-issue.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-issue(1) +fcli_version: +--- + + + + + + + +fcli-ssc-issue(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc issue [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
create-template
+
+

Create/upload an issue template.

+
+
delete-template, rmt
+
+

Delete an issue template.

+
+
download-template
+
+

Download an issue template.

+
+
get-template
+
+

Get issue template details.

+
+
list-templates, lst
+
+

List issue templates.

+
+
update-template
+
+

Update an issue template.

+
+
get-filterset
+
+

Get filter set details.

+
+
list-filtersets, lsfs
+
+

List application version filter sets.

+
+
get-filter
+
+

Get issue filter details.

+
+
list-filters, lsf
+
+

List application version issue filters.

+
+
get-group
+
+

Get issue group details.

+
+
list-groups, lsg
+
+

List application version issue groups.

+
+
count
+
+

Count application version vulnerabilities by grouping.

+
+
list, ls
+
+

List application version vulnerabilities.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-performance-indicator-get.html b/v2.10.1/manpage/fcli-ssc-performance-indicator-get.html new file mode 100644 index 000000000..cf09fb960 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-performance-indicator-get.html @@ -0,0 +1,161 @@ +--- +title: fcli-ssc-performance-indicator-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-performance-indicator-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc performance-indicator get --av=<appVersionNameOrId> + [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <performanceIndicatorNameOrIdOrGuid>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<performanceIndicatorNameOrIdOrGuid>
+
+

Performance indicator name, id, or guid.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-performance-indicator-list-definitions.html b/v2.10.1/manpage/fcli-ssc-performance-indicator-list-definitions.html new file mode 100644 index 000000000..5529b9aa8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-performance-indicator-list-definitions.html @@ -0,0 +1,138 @@ +--- +title: fcli-ssc-performance-indicator-list-definitions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-performance-indicator-list-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc performance-indicator list-definitions [[-h] +[--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] +[[--session=<sessionName>]] ] [--store=_variableName[: +<propertyNames>]] [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-performance-indicator-list.html b/v2.10.1/manpage/fcli-ssc-performance-indicator-list.html new file mode 100644 index 000000000..13f23b93d --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-performance-indicator-list.html @@ -0,0 +1,151 @@ +--- +title: fcli-ssc-performance-indicator-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-performance-indicator-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc performance-indicator list --av=<appVersionNameOrId> + [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-performance-indicator.html b/v2.10.1/manpage/fcli-ssc-performance-indicator.html new file mode 100644 index 000000000..dc46214c7 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-performance-indicator.html @@ -0,0 +1,97 @@ +--- +title: fcli-ssc-performance-indicator(1) +fcli_version: +--- + + + + + + + +fcli-ssc-performance-indicator(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc performance-indicator [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

Performance indicator and variable commands may potentially be combined under a single 'metrics' entity, we’re still considering the pro’s and con’s of either approach.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list-definitions, lsd
+
+

(PREVIEW) List performance indicator definitions.

+
+
get
+
+

(PREVIEW) Get performance indicator details.

+
+
list, ls
+
+

(PREVIEW) List application version performance indicators.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-disable.html b/v2.10.1/manpage/fcli-ssc-plugin-disable.html new file mode 100644 index 000000000..eb4ed9bd8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-disable.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-plugin-disable(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-disable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin disable [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <numericPluginId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<numericPluginId>
+
+

Numeric plugin id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-enable.html b/v2.10.1/manpage/fcli-ssc-plugin-enable.html new file mode 100644 index 000000000..9519383fa --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-enable.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-plugin-enable(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-enable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin enable [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <numericPluginId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<numericPluginId>
+
+

Numeric plugin id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-get.html b/v2.10.1/manpage/fcli-ssc-plugin-get.html new file mode 100644 index 000000000..c04e68140 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-get.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-plugin-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <numericPluginId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<numericPluginId>
+
+

Numeric plugin id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-install.html b/v2.10.1/manpage/fcli-ssc-plugin-install.html new file mode 100644 index 000000000..a960d9fb6 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-install.html @@ -0,0 +1,143 @@ +--- +title: fcli-ssc-plugin-install(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin install [--[no-]auto-enable] -f=<file> [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Plugin jar file to install.

+
+
--[no-]auto-enable
+
+

The plugin being installed will be enabled automatically, unless the --no-auto-enable option is provided.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-list.html b/v2.10.1/manpage/fcli-ssc-plugin-list.html new file mode 100644 index 000000000..1048b9c5b --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-list.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-plugin-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin-uninstall.html b/v2.10.1/manpage/fcli-ssc-plugin-uninstall.html new file mode 100644 index 000000000..012ac8576 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin-uninstall.html @@ -0,0 +1,154 @@ +--- +title: fcli-ssc-plugin-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin uninstall [--[no-]auto-disable] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <numericPluginId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--[no-]auto-disable
+
+

The plugin being deleted will be automatically disabled, unless the --no-auto-disable option is provided.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<numericPluginId>
+
+

Numeric plugin id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-plugin.html b/v2.10.1/manpage/fcli-ssc-plugin.html new file mode 100644 index 000000000..781de1aad --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-plugin.html @@ -0,0 +1,107 @@ +--- +title: fcli-ssc-plugin(1) +fcli_version: +--- + + + + + + + +fcli-ssc-plugin(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc plugin [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Install a plugin.

+
+
uninstall
+
+

Uninstall a plugin.

+
+
enable
+
+

Enable a plugin.

+
+
disable
+
+

Disable a plugin.

+
+
get
+
+

Get plugin details.

+
+
list, ls
+
+

List plugins.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-create-template-config.html b/v2.10.1/manpage/fcli-ssc-report-create-template-config.html new file mode 100644 index 000000000..d5ce91fb9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-create-template-config.html @@ -0,0 +1,133 @@ +--- +title: fcli-ssc-report-create-template-config(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-create-template-config(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report create-template-config [-y] [-c=<outputFileName>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

Generate a sample report template configuration file for use by the 'create' command. This configuration file defines settings like the name of the report template, what parameters it accepts, and the types for those parameters.

+
+
+
+
+

Options

+
+
+
+
-c, --config=<outputFileName>
+
+

Output file for the generated configuration.

+
+
-y, --confirm
+
+

Confirm overwriting existing configuration file.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-create-template.html b/v2.10.1/manpage/fcli-ssc-report-create-template.html new file mode 100644 index 000000000..13eac5697 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-create-template.html @@ -0,0 +1,145 @@ +--- +title: fcli-ssc-report-create-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-create-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report create-template [-c=<answerFile>] -t=<templatePath> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-c, --config=<answerFile>
+
+

File containing report template configuration, like report parameters. You can use the 'generate-config' command to create a new configuration file template.

+
+
-t, --template=<templatePath>
+
+

BIRT report template to be uploaded to SSC.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-create.html b/v2.10.1/manpage/fcli-ssc-report-create.html new file mode 100644 index 000000000..93e459ab4 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-create.html @@ -0,0 +1,161 @@ +--- +title: fcli-ssc-report-create(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-create(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report create [--delim=<delimiter>] [-f=<format>] -n=<reportName> + [--notes=<notes>] --template=<reportTemplateNameOrId> + [-p=PARAM=VALUE[,PARAM=VALUE…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-f, --format=<format>
+
+

Report format. Allowed values: xls, doc, pdf.

+
+
-n, --name=<reportName>
+
+

Name for the generated report.

+
+
--notes=<notes>
+
+

Notes for the generated report.

+
+
-p, --parameters=PARAM=VALUE[,PARAM=VALUE…​]
+
+

Report generation parameters, dependent on report template.

+
+
--template=<reportTemplateNameOrId>
+
+

The name or ID of the report template definition.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-delete-template.html b/v2.10.1/manpage/fcli-ssc-report-delete-template.html new file mode 100644 index 000000000..cfaefb3f1 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-delete-template.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-report-delete-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-delete-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report delete-template [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <reportTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportTemplateNameOrId>
+
+

The name or ID of the report template definition.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-delete.html b/v2.10.1/manpage/fcli-ssc-report-delete.html new file mode 100644 index 000000000..735868398 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-delete.html @@ -0,0 +1,139 @@ +--- +title: fcli-ssc-report-delete(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report delete [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <reportNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportNameOrId>
+
+

Report name or id. If multiple reports with the same name exist on SSC, you must specify the report id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-download-template.html b/v2.10.1/manpage/fcli-ssc-report-download-template.html new file mode 100644 index 000000000..685c5402c --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-download-template.html @@ -0,0 +1,155 @@ +--- +title: fcli-ssc-report-download-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-download-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report download-template [-f=<file>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <reportTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Optional issue template file path.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportTemplateNameOrId>
+
+

The name or ID of the report template definition.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-download.html b/v2.10.1/manpage/fcli-ssc-report-download.html new file mode 100644 index 000000000..be409c6cf --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-download.html @@ -0,0 +1,153 @@ +--- +title: fcli-ssc-report-download(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-download(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report download [-f=<file>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <reportNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Optional output file name.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportNameOrId>
+
+

Report name or id. If multiple reports with the same name exist on SSC, you must specify the report id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-get-template.html b/v2.10.1/manpage/fcli-ssc-report-get-template.html new file mode 100644 index 000000000..32467b44f --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-get-template.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-report-get-template(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-get-template(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report get-template [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <reportTemplateNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportTemplateNameOrId>
+
+

The name or ID of the report template definition.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-get.html b/v2.10.1/manpage/fcli-ssc-report-get.html new file mode 100644 index 000000000..e3beec27d --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-get.html @@ -0,0 +1,138 @@ +--- +title: fcli-ssc-report-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] <reportNameOrId>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<reportNameOrId>
+
+

Report name or id. If multiple reports with the same name exist on SSC, you must specify the report id.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-list-parameters.html b/v2.10.1/manpage/fcli-ssc-report-list-parameters.html new file mode 100644 index 000000000..5a121b9dd --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-list-parameters.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-report-list-parameters(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-list-parameters(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report list-parameters --template=<reportTemplateNameOrId> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--template=<reportTemplateNameOrId>
+
+

The name or ID of the report template definition.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-list-templates.html b/v2.10.1/manpage/fcli-ssc-report-list-templates.html new file mode 100644 index 000000000..5bc499adb --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-list-templates.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-report-list-templates(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-list-templates(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report list-templates [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-list.html b/v2.10.1/manpage/fcli-ssc-report-list.html new file mode 100644 index 000000000..7b4ea4c01 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-list.html @@ -0,0 +1,143 @@ +--- +title: fcli-ssc-report-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report list [--q-param=<qParam>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report-wait-for.html b/v2.10.1/manpage/fcli-ssc-report-wait-for.html new file mode 100644 index 000000000..0bc1ecfbf --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report-wait-for.html @@ -0,0 +1,196 @@ +--- +title: fcli-ssc-report-wait-for(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report-wait-for(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report wait-for [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownStateRequested> + ] [--progress=<type>] [-t=<timeoutPeriod>] [-s=<states> + [,<states>…​]]…​ [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-u=any-match|all-match | -w=any-match|all-match] + [[--session=<sessionName>]] report names or id’s…​

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more report states against which to match the given reports.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all reports match. If neither --until or --while are specified, default is to wait until all reports match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all reports match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
report names or id’s…​
+
+

Report names or id’s.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-report.html b/v2.10.1/manpage/fcli-ssc-report.html new file mode 100644 index 000000000..bc005b439 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-report.html @@ -0,0 +1,135 @@ +--- +title: fcli-ssc-report(1) +fcli_version: +--- + + + + + + + +fcli-ssc-report(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc report [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
create
+
+

Generate a report on SSC.

+
+
list, ls
+
+

List SSC reports.

+
+
get
+
+

Get SSC report details.

+
+
download
+
+

Download an SSC report.

+
+
wait-for
+
+

Wait for SSC report generation.

+
+
delete, rm
+
+

Delete a report from SSC.

+
+
list-parameters, lsp
+
+

List SSC report parameters.

+
+
create-template
+
+

Create/upload a report template.

+
+
list-templates, lst
+
+

List report template definitions.

+
+
get-template
+
+

Get report template details.

+
+
download-template
+
+

Download a report template file.

+
+
create-template-config
+
+

Generate a sample report template configuration file.

+
+
delete-template, rmt
+
+

Delete a report template.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-rest-call.html b/v2.10.1/manpage/fcli-ssc-rest-call.html new file mode 100644 index 000000000..f4f4a10f3 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-rest-call.html @@ -0,0 +1,174 @@ +--- +title: fcli-ssc-rest-call(1) +fcli_version: +--- + + + + + + + +fcli-ssc-rest-call(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc rest call [--no-paging] [-d=<data>] [-X=<httpMethod>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--no-transform] | -t=<expr>] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>] [[--session=<sessionName>]] <uri>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-d, --data=<data>
+
+

Data to send in the request body. This option takes either a string to be sent as request body, or @@<file> to send the contents of the given file as the request body (note the double at-sign). This option is not available for GET requests.

+
+
--no-paging
+
+

By default, this command will load all pages of data from SSC (from the given offset if specified as a request parameter). Use this option to return only a single page.

+
+
--no-transform
+
+

By default, this command performs generic transformations on SSC REST responses, like only outputting the actual response data (contents of the 'data' property). Use this option to output the original response contents without transformations.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-t, --transform=<expr>
+
+

This option allows for performing custom transformations on the response data based on a Spring Expression Language (SpEL) expression. For example, this allows for retrieving data from sub-properties, or using project selection/projection. Note that the expression operates on the raw response, as if --no-transform was specified before evaluating the expression.

+
+
-X, --request=<httpMethod>
+
+

HTTP method/verb to use for the API request, like GET, POST, DELETE, …​ Default value: GET.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<uri>
+
+

Relative URI to the REST API endpoint that you want to invoke.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-rest.html b/v2.10.1/manpage/fcli-ssc-rest.html new file mode 100644 index 000000000..cd28b9ceb --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-rest.html @@ -0,0 +1,89 @@ +--- +title: fcli-ssc-rest(1) +fcli_version: +--- + + + + + + + +fcli-ssc-rest(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc rest [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

These commands allow for direct interaction with SSC REST API endpoints, somewhat similar to using 'curl' but benefiting from standard fcli functionality like session management (no need to manually specify Authorization header), rich output formatting options, and query functionality.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
call
+
+

Call an individual Fortify SSC REST API endpoint.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-session-list.html b/v2.10.1/manpage/fcli-ssc-session-list.html new file mode 100644 index 000000000..a1b3499f0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-session-list.html @@ -0,0 +1,132 @@ +--- +title: fcli-ssc-session-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-session-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc session list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

This commands lists all SSC sessions created through the login command, as long as they haven’t been explicitly terminated through the 'logout' command.

+
+
+

For sessions created using user name and password, the output of this command will show session expiry date and status, based on the data provided by SSC at the time the login command was issued. Any changes to the generated token will not be reflected in the output of this command. Even if a session is no longer valid because the generated token was revoked (through SSC UI or 'fcli ssc access-control revoke-token' command), the output of this command may still show the session as not having expired. Similarly, any changes to token validity will not be reflected in the output of this command.

+
+
+

For sessions created using a pre-generated token, fcli cannot display session expiration date or status, as SSC doesn’t allow for obtaining this information.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-session-login.html b/v2.10.1/manpage/fcli-ssc-session-login.html new file mode 100644 index 000000000..69b25ef2b --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-session-login.html @@ -0,0 +1,238 @@ +--- +title: fcli-ssc-session-login(1) +fcli_version: +--- + + + + + + + +fcli-ssc-session-login(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc session login [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] ([-k] + [--socket-timeout=<socketTimeout>] + [--connect-timeout=<connectTimeout>] --url=<url>) + ((-u=<user> -p[=<password>] [--expire-in=<expireIn>]) | + -t[=<token>] | --ci-token[=<token>])

+
+
+
+
+

Description

+
+
+

This command stores the SSC URL and authentication token in an encrypted session file in the fcli state data folder, for use by other 'fcli ssc' commands to connect to the specified SSC instance. Option values may be passed on the command line or specified through environment variables (common for CI/CD pipeline use) as listed below.

+
+
+

When logging in with username and password, this command will connect to SSC to generate a UnifiedLoginToken; the user password is not stored by fcli. When logging in with a pre-generated token, this token will be stored as-is after checking its validity. Note that depending on token type, some 'fcli ssc' commands may fail due to the token not being allowed to access the necessary SSC API endpoints. Also note that on SSC 23.2 or below, fcli cannot determine when a pre-generated token will expire.

+
+
+

For interactive use, you may choose to keep the session open until it expires. For CI/CD integrations and other automations, you should always issue a logout command once work is complete. On shared/non-containerized systems, consider setting FCLI_STATE_DIR or FCLI_DATA_DIR environment variables to prevent unexpected interactions between different pipelines.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name for this SSC session. Default value: default.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--expire-in=<expireIn>
+
+

Specify for how long the session should remain active, for example 1h (1 hour), 1d (1 day).

+
+
+
Default: 1d
+
+
+
+
-t, --token[=<token>]
+
+

SSC token in either encoded (REST) or decoded (application) format. Tokens can be created through the SSC web UI, or using the 'fcli ssc access-control create-token' command. Note that depending on token permissions, not all fcli commands may be available.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_TOKEN
+
+
+
+
--ci-token[=<token>]
+
+

SSC CIToken in either encoded (REST) or decoded (application) format. Tokens can be created through the SSC web UI, or using the 'fcli ssc access-control create-token' command. Note that most, but not all, fcli commands are available when logging in with a CIToken.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_CI_TOKEN: Only SSC session commands
+
+
+
+
--url=<url>
+
+

SSC URL.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_URL: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_URL: Only SSC session commands
+
+
+
+
-k, --insecure
+
+

Disable SSL checks.

+
+
--socket-timeout=<socketTimeout>
+
+

Socket timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 5 minutes.

+
+
--connect-timeout=<connectTimeout>
+
+

Connection timeout for this session, for example 30s (30 seconds), 5m (5 minutes). Default value: 10 seconds.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-session-logout.html b/v2.10.1/manpage/fcli-ssc-session-logout.html new file mode 100644 index 000000000..3058aed7c --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-session-logout.html @@ -0,0 +1,174 @@ +--- +title: fcli-ssc-session-logout(1) +fcli_version: +--- + + + + + + + +fcli-ssc-session-logout(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc session logout [--no-revoke-token] [--session=<sessionName>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-u=<user> -p[=<password>]]

+
+
+
+
+

Description

+
+
+

This command terminates an SSC session previously created through the 'login' command.

+
+
+

If the session was created with user credentials, this command will revoke the automatically generated SSC token unless the --no-revoke-token option is specified. On SSC 24.2 or above, the automatically generated token can be revoked without providing user credentials. For SSC 23.2 or below, user credentials are required to revoke the automatically generated token; the logout command will throw an error if neither user credentials nor --no-revoke-token option is specified, and the session will not be terminated.

+
+
+

If the session was created with a pre-generated token, the session will always be terminated without revoking the pre-generated token. As such, no user credentials need to be provided, and the --no-revoke-token option will have no effect.

+
+
+

To summarize: No user credentials nor --no-revoke-token option should be specified if the session was created with a pre-generated token or if the session is connected to SSC 24.2 or above. Either user credentials or --no-revoke-token option must be specified if the session was created with user credentials AND the session is connected to SSC 23.2 or below.

+
+
+
+
+

Options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to be terminated. Default value: default.

+
+
-u, --user=<user>
+
+

SSC user name.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
+
+
+
+
-p, --password[=<password>]
+
+

SSC password.

+
+

Environment variables:

+
+
+
+
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
+
+
+
+
+
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
+
+
+
+
--no-revoke-token
+
+

It is highly recommended to have fcli revoke the token that was automatically generated if the session was created using user credentials to avoid exceeding SSCs maximum token limit. This option is provided for convenience only, to allow the session to be terminated without having to specify user credentials on SSC 23.2 or below. Once most users have upgraded to SSC 24.2 or above, this option will be deprecated or removed.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-session.html b/v2.10.1/manpage/fcli-ssc-session.html new file mode 100644 index 000000000..1443b20ec --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-session.html @@ -0,0 +1,97 @@ +--- +title: fcli-ssc-session(1) +fcli_version: +--- + + + + + + + +fcli-ssc-session(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc session [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The session commands allow for managing one or more SSC sessions used to connect to a particular SSC instance with particular credentials. Potentially you can have multiple open SSC sessions, for example connecting to different SSC instances like DEV and PROD, or connecting to the same SSC instance but with different credentials.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List active and expired Fortify SSC sessions.

+
+
login
+
+

Create a session for interacting with Fortify SSC.

+
+
logout
+
+

Terminate Fortify SSC session.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-cancel-job.html b/v2.10.1/manpage/fcli-ssc-system-state-cancel-job.html new file mode 100644 index 000000000..4f282119a --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-cancel-job.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-system-state-cancel-job(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-cancel-job(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state cancel-job [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <jobName>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<jobName>
+
+

Job name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-get-job.html b/v2.10.1/manpage/fcli-ssc-system-state-get-job.html new file mode 100644 index 000000000..01b9e1415 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-get-job.html @@ -0,0 +1,140 @@ +--- +title: fcli-ssc-system-state-get-job(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-get-job(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state get-job [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <jobName>

+
+
+
+
+

Description

+
+ +
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<jobName>
+
+

Job name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-list-activities.html b/v2.10.1/manpage/fcli-ssc-system-state-list-activities.html new file mode 100644 index 000000000..fd01cf729 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-list-activities.html @@ -0,0 +1,147 @@ +--- +title: fcli-ssc-system-state-list-activities(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-list-activities(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state list-activities [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-list-events.html b/v2.10.1/manpage/fcli-ssc-system-state-list-events.html new file mode 100644 index 000000000..9e62097b3 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-list-events.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-system-state-list-events(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-list-events(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state list-events [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-list-jobs.html b/v2.10.1/manpage/fcli-ssc-system-state-list-jobs.html new file mode 100644 index 000000000..1d1072ec4 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-list-jobs.html @@ -0,0 +1,146 @@ +--- +title: fcli-ssc-system-state-list-jobs(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-list-jobs(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state list-jobs [--q-param=<qParam>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
--q-param=<qParam>
+
+

Server-side queries are automatically generated from the -q / --query option if possible; generated queries can be viewed in the debug log. The --q-param option can be used to override the automatically generated query, for example to further optimize the request. See SSC REST API documentation for information on supported formats.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-list-rulepacks.html b/v2.10.1/manpage/fcli-ssc-system-state-list-rulepacks.html new file mode 100644 index 000000000..9e88d5b6d --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-list-rulepacks.html @@ -0,0 +1,142 @@ +--- +title: fcli-ssc-system-state-list-rulepacks(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-list-rulepacks(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state list-rulepacks [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-list-settings.html b/v2.10.1/manpage/fcli-ssc-system-state-list-settings.html new file mode 100644 index 000000000..1153c21e8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-list-settings.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-system-state-list-settings(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-list-settings(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state list-settings [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-update-job.html b/v2.10.1/manpage/fcli-ssc-system-state-update-job.html new file mode 100644 index 000000000..e8acf6236 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-update-job.html @@ -0,0 +1,156 @@ +--- +title: fcli-ssc-system-state-update-job(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-update-job(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state update-job --priority=<priority> [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <jobName>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--priority=<priority>
+
+

New priority for this job.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<jobName>
+
+

Job name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-upload-seed-bundle.html b/v2.10.1/manpage/fcli-ssc-system-state-upload-seed-bundle.html new file mode 100644 index 000000000..05d5f3bbc --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-upload-seed-bundle.html @@ -0,0 +1,138 @@ +--- +title: fcli-ssc-system-state-upload-seed-bundle(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-upload-seed-bundle(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state upload-seed-bundle -f=<file> [[-h] +[--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] +[[--session=<sessionName>]] ] [--store=_variableName[: +<propertyNames>]] [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-f, --file=<file>
+
+

Seed bundle to upload.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state-wait-for-job.html b/v2.10.1/manpage/fcli-ssc-system-state-wait-for-job.html new file mode 100644 index 000000000..a0fbeb4b8 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state-wait-for-job.html @@ -0,0 +1,200 @@ +--- +title: fcli-ssc-system-state-wait-for-job(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state-wait-for-job(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state wait-for-job [-i=<intervalPeriod>] + [--on-failure-state=<onFailureState>] + [--on-timeout=<onTimeout>] + [--on-unknown-state=<onUnknownState>] + [--on-unknown-state-requested=<onUnknownState + _ Requested>_] [--progress=<type>] + [-t=<timeoutPeriod>] [-s=<states>[, + <states>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-u=any-match|all-match | + -w=any-match|all-match] + [[--session=<sessionName>]] job-names…​

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-i, --interval=<intervalPeriod>
+
+

Polling interval, for example 5s (5 seconds) or 1m (1 minute).

+
+
--on-failure-state=<onFailureState>
+
+

Action to take when a failure state is returned for any of the records: wait, terminate, fail.

+
+
--on-timeout=<onTimeout>
+
+

Action to take when timeout occurs: terminate, fail.

+
+
--on-unknown-state=<onUnknownState>
+
+

Action to take when an unknown state is returned for any of the records: wait, terminate, fail.

+
+
--on-unknown-state-requested=<onUnknownStateRequested>
+
+

Action to take when an unknown state is passed in any of the --while or --until options: ignore, fail.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-s, --any-state=<states>[,<states>…​]
+
+

One or more processing states against which to match the given jobs.

+
+
-t, --timeout=<timeoutPeriod>
+
+

Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour).

+
+
-u, --until=any-match|all-match
+
+

Wait until either any or all jobs match. If neither --until or --while are specified, default is to wait until all jobs match.

+
+
-w, --while=any-match|all-match
+
+

Wait while either any or all jobs match.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
job-names…​
+
+

One or more job names

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-system-state.html b/v2.10.1/manpage/fcli-ssc-system-state.html new file mode 100644 index 000000000..659c0ba22 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-system-state.html @@ -0,0 +1,123 @@ +--- +title: fcli-ssc-system-state(1) +fcli_version: +--- + + + + + + + +fcli-ssc-system-state(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc system-state [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list-activities, lsa
+
+

List activity feed entries.

+
+
list-events, lse
+
+

List system events.

+
+
list-settings, lss
+
+

List system settings.

+
+
upload-seed-bundle
+
+

Upload a seed bundle.

+
+
list-rulepacks, lsr
+
+

List installed rule packs.

+
+
cancel-job
+
+

Cancel a job.

+
+
get-job
+
+

Get job details.

+
+
list-jobs, lsj
+
+

List jobs.

+
+
update-job
+
+

Update job priority.

+
+
wait-for-job
+
+

Wait for multiple system jobs

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-variable-get.html b/v2.10.1/manpage/fcli-ssc-variable-get.html new file mode 100644 index 000000000..9c2b11bc9 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-variable-get.html @@ -0,0 +1,158 @@ +--- +title: fcli-ssc-variable-get(1) +fcli_version: +--- + + + + + + + +fcli-ssc-variable-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc variable get --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <VariableNameOrIdOrGuid>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<VariableNameOrIdOrGuid>
+
+

Variable name, id, or guid.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-variable-list-definitions.html b/v2.10.1/manpage/fcli-ssc-variable-list-definitions.html new file mode 100644 index 000000000..3554d9d44 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-variable-list-definitions.html @@ -0,0 +1,141 @@ +--- +title: fcli-ssc-variable-list-definitions(1) +fcli_version: +--- + + + + + + + +fcli-ssc-variable-list-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc variable list-definitions [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] + [[--session=<sessionName>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-variable-list.html b/v2.10.1/manpage/fcli-ssc-variable-list.html new file mode 100644 index 000000000..0b43ed723 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-variable-list.html @@ -0,0 +1,148 @@ +--- +title: fcli-ssc-variable-list(1) +fcli_version: +--- + + + + + + + +fcli-ssc-variable-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc variable list --av=<appVersionNameOrId> [--delim=<delimiter>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [[--session=<sessionName>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--av, --appversion=<appVersionNameOrId>
+
+

Application version id or <application>:<version> name.

+
+
--delim=<delimiter>
+
+

Change the default delimiter character when using options that accept "application:version" as an argument or parameter.

+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Session options

+
+
+
+
--session=<sessionName>
+
+

Name of the SSC session to use for executing this command. Default value: default.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc-variable.html b/v2.10.1/manpage/fcli-ssc-variable.html new file mode 100644 index 000000000..7ba9b80d0 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc-variable.html @@ -0,0 +1,97 @@ +--- +title: fcli-ssc-variable(1) +fcli_version: +--- + + + + + + + +fcli-ssc-variable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc variable [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

Performance indicator and variable commands may potentially be combined under a single 'metrics' entity, we’re still considering the pro’s and con’s of either approach.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list-definitions, lsd
+
+

(PREVIEW) List variable definitions.

+
+
get
+
+

(PREVIEW) Get variable details.

+
+
list, ls
+
+

(PREVIEW) List application version variables.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-ssc.html b/v2.10.1/manpage/fcli-ssc.html new file mode 100644 index 000000000..3999c5545 --- /dev/null +++ b/v2.10.1/manpage/fcli-ssc.html @@ -0,0 +1,148 @@ +--- +title: fcli-ssc(1) +fcli_version: +--- + + + + + + + +fcli-ssc(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli ssc [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for interacting with Fortify Software Security Center (SSC). This includes functionality like managing applications, application versions and their contents like artifacts and vulnerability data, as well as working with other SSC entities like event logs, alerts, plugins, and so on.

+
+
+

Before being able to interact with SSC, a session will need to be created by passing SSC URL and credentials to the 'session login' command in this module. As a best practice, 'session logout' should be run to terminate the session when there are no more activities to be performed.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
session
+
+

Manage SSC sessions (start here).

+
+
action
+
+

Manage SSC actions: data export, integration, automation & more.

+
+
access-control, ac
+
+

Manage SSC users, roles & tokens.

+
+
alert
+
+

Manage SSC alerts & definitions.

+
+
app
+
+

Manage SSC applications.

+
+
appversion, av
+
+

Manage SSC application versions.

+
+
artifact
+
+

Manage SSC artifacts.

+
+
attribute, attr
+
+

Manage SSC application version attributes & definitions.

+
+
issue
+
+

Manage SSC issues (vulnerabilities) and related entities like issue templates, filters and groups.

+
+
performance-indicator, pi
+
+

(PREVIEW) Manage SSC performance indicators & definitions.

+
+
variable, var
+
+

(PREVIEW) Manage SSC variables & definitions.

+
+
plugin
+
+

Manage SSC parser & bug tracker plugins.

+
+
report
+
+

Manage SSC reports & templates.

+
+
system-state, state
+
+

View & manage SSC system state (logs, jobs, …​)

+
+
rest
+
+

Interact with SSC REST API endpoints.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-bugtracker-utility-install.html b/v2.10.1/manpage/fcli-tool-bugtracker-utility-install.html new file mode 100644 index 000000000..c833586d5 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-bugtracker-utility-install.html @@ -0,0 +1,188 @@ +--- +title: fcli-tool-bugtracker-utility-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-bugtracker-utility-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool bugtracker-utility install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] + [-v=<version>] [-u=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] [-d=<installDir> + | -b=<baseDir>] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-bugtracker-utility-list-platforms.html b/v2.10.1/manpage/fcli-tool-bugtracker-utility-list-platforms.html new file mode 100644 index 000000000..ca75d7de5 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-bugtracker-utility-list-platforms.html @@ -0,0 +1,128 @@ +--- +title: fcli-tool-bugtracker-utility-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-bugtracker-utility-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool bugtracker-utility list-platforms [-v=<version>] [[-h] +[--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] +] [--store=_variableName[:<propertyNames>]] +[--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-bugtracker-utility-list.html b/v2.10.1/manpage/fcli-tool-bugtracker-utility-list.html new file mode 100644 index 000000000..0c61aaa1d --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-bugtracker-utility-list.html @@ -0,0 +1,128 @@ +--- +title: fcli-tool-bugtracker-utility-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-bugtracker-utility-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool bugtracker-utility list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-bugtracker-utility-uninstall.html b/v2.10.1/manpage/fcli-tool-bugtracker-utility-uninstall.html new file mode 100644 index 000000000..2ae33a5dc --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-bugtracker-utility-uninstall.html @@ -0,0 +1,141 @@ +--- +title: fcli-tool-bugtracker-utility-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-bugtracker-utility-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool bugtracker-utility uninstall [-y] [--progress=<type>] + -v=<versionsToUninstall>[, + <versionsToUninstall>…​] + [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command removes one or more FortifyBugTrackerUtility installations that were previously installed using the 'fcli tool bugtracker-utility install' command. Note that global bin scripts, if installed, will not be updated or removed by this command. If you un-install the version to which the global bin-script is currently pointing, the global bin script will cease functioning. To update the global bin script to point to an existing version, please use the install command.

+
+
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of FortifyBugTrackerUtility.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-bugtracker-utility.html b/v2.10.1/manpage/fcli-tool-bugtracker-utility.html new file mode 100644 index 000000000..39530d345 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-bugtracker-utility.html @@ -0,0 +1,101 @@ +--- +title: fcli-tool-bugtracker-utility(1) +fcli_version: +--- + + + + + + + +fcli-tool-bugtracker-utility(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool bugtracker-utility [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

For more information about FortifyBugTrackerUtility, please see the source code repository at https://github.com/fortify-ps/FortifyBugTrackerUtility.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install FortifyBugTrackerUtility.

+
+
list, ls
+
+

List available and installed FortifyBugTrackerUtility versions.

+
+
list-platforms, lsp
+
+

List available platforms for FortifyBugTrackerUtility

+
+
uninstall
+
+

Uninstall FortifyBugTrackerUtility.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-debricked-cli-install.html b/v2.10.1/manpage/fcli-tool-debricked-cli-install.html new file mode 100644 index 000000000..b0273ca25 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-debricked-cli-install.html @@ -0,0 +1,188 @@ +--- +title: fcli-tool-debricked-cli-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-debricked-cli-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool debricked-cli install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] + [-v=<version>] [-u=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] [-d=<installDir> | + -b=<baseDir>] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-debricked-cli-list-platforms.html b/v2.10.1/manpage/fcli-tool-debricked-cli-list-platforms.html new file mode 100644 index 000000000..357e50030 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-debricked-cli-list-platforms.html @@ -0,0 +1,132 @@ +--- +title: fcli-tool-debricked-cli-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-debricked-cli-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool debricked-cli list-platforms [-v=<version>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-debricked-cli-list.html b/v2.10.1/manpage/fcli-tool-debricked-cli-list.html new file mode 100644 index 000000000..045092c18 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-debricked-cli-list.html @@ -0,0 +1,127 @@ +--- +title: fcli-tool-debricked-cli-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-debricked-cli-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool debricked-cli list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-debricked-cli-uninstall.html b/v2.10.1/manpage/fcli-tool-debricked-cli-uninstall.html new file mode 100644 index 000000000..de7e6f411 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-debricked-cli-uninstall.html @@ -0,0 +1,140 @@ +--- +title: fcli-tool-debricked-cli-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-debricked-cli-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool debricked-cli uninstall [-y] [--progress=<type>] + -v=<versionsToUninstall>[, + <versionsToUninstall>…​] + [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command removes one or more Debricked CLI installations that were previously installed using the 'fcli tool debricked install' command. Note that global bin scripts, if installed, will not be updated or removed by this command. If you un-install the version to which the global bin-script is currently pointing, the global bin script will cease functioning. To update the global bin script to point to an existing version, please use the install command.

+
+
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of Debricked CLI.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-debricked-cli.html b/v2.10.1/manpage/fcli-tool-debricked-cli.html new file mode 100644 index 000000000..b6e13cc11 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-debricked-cli.html @@ -0,0 +1,101 @@ +--- +title: fcli-tool-debricked-cli(1) +fcli_version: +--- + + + + + + + +fcli-tool-debricked-cli(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool debricked-cli [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

For more information about Debricked CLI, please see the source code repository at https://github.com/debricked/cli.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install the Debricked CLI.

+
+
list, ls
+
+

List available and installed Debricked CLI versions.

+
+
list-platforms, lsp
+
+

List available platforms for Debricked CLI

+
+
uninstall
+
+

Uninstall Debricked CLI.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-definitions-list.html b/v2.10.1/manpage/fcli-tool-definitions-list.html new file mode 100644 index 000000000..a5ce254f7 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-definitions-list.html @@ -0,0 +1,110 @@ +--- +title: fcli-tool-definitions-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-definitions-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool definitions list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-definitions-reset.html b/v2.10.1/manpage/fcli-tool-definitions-reset.html new file mode 100644 index 000000000..adc1f9ea5 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-definitions-reset.html @@ -0,0 +1,112 @@ +--- +title: fcli-tool-definitions-reset(1) +fcli_version: +--- + + + + + + + +fcli-tool-definitions-reset(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool definitions reset [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command removes any tool definition updates, reverting to the tool definitions originally shipped with this fcli release.

+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-definitions-update.html b/v2.10.1/manpage/fcli-tool-definitions-update.html new file mode 100644 index 000000000..a996836f5 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-definitions-update.html @@ -0,0 +1,132 @@ +--- +title: fcli-tool-definitions-update(1) +fcli_version: +--- + + + + + + + +fcli-tool-definitions-update(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool definitions update [-s=<source>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

Tool definitions list the available versions, corresponding download location, and other details for each tool. These tool definitions are used by the various 'fcli tool' commands to identify what tool versions are currently available and where to download them from. By default, each fcli release ships with the latest tool definitions that were available at the time that release was built.

+
+
+

The update command allows for updating the tool definitions from a URL or local file. This allows for the current fcli installation to be aware of new tool versions that were released after the current fcli release was built, and also allows users to use a custom tool definitions bundle.

+
+
+

For example, if it’s not allowed to download tool installation bundles from public sites like github.com or tools.fortify.com, companies can host tool installation bundles internally and provide a tool definitions bundle that points to the internally hosted installation bundles. At the same time, companies can restrict which versions of each tool users are allowed to install.

+
+
+
+
+

Options

+
+
+
+
-s, --source=<source>
+
+

URL or file to get the tool definitions from. If not specified, default tool definitions provided by OpenText are downloaded from a predefined URL.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-definitions.html b/v2.10.1/manpage/fcli-tool-definitions.html new file mode 100644 index 000000000..f700b563d --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-definitions.html @@ -0,0 +1,100 @@ +--- +title: fcli-tool-definitions(1) +fcli_version: +--- + + + + + + + +fcli-tool-definitions(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool definitions [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

Tool definitions list the available versions, corresponding download location, and other details for each tool. These tool definitions are used by the various 'fcli tool' commands to identify what tool versions are currently available and where to download them from. By default, each fcli release ships with the latest tool definitions that were available at the time that release was built.

+
+
+

The commands in this module allow for managing tool definitions, like updating tool definitions from a URL or local file.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
list, ls
+
+

List tool definitions.

+
+
update
+
+

Update tool definitions.

+
+
reset
+
+

Reset tool definitions.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fcli-install.html b/v2.10.1/manpage/fcli-tool-fcli-install.html new file mode 100644 index 000000000..3af9b664d --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fcli-install.html @@ -0,0 +1,186 @@ +--- +title: fcli-tool-fcli-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-fcli-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fcli install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] [-v=<version>] + [-u=<versionsToUninstall>[,<versionsToUninstall>…​]]…​ + [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [-d=<installDir> | + -b=<baseDir>] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fcli-list-platforms.html b/v2.10.1/manpage/fcli-tool-fcli-list-platforms.html new file mode 100644 index 000000000..f59b3216c --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fcli-list-platforms.html @@ -0,0 +1,129 @@ +--- +title: fcli-tool-fcli-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-fcli-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fcli list-platforms [-v=<version>] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fcli-list.html b/v2.10.1/manpage/fcli-tool-fcli-list.html new file mode 100644 index 000000000..c9085c81c --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fcli-list.html @@ -0,0 +1,126 @@ +--- +title: fcli-tool-fcli-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-fcli-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fcli list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fcli-uninstall.html b/v2.10.1/manpage/fcli-tool-fcli-uninstall.html new file mode 100644 index 000000000..80c8f23ee --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fcli-uninstall.html @@ -0,0 +1,137 @@ +--- +title: fcli-tool-fcli-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-fcli-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fcli uninstall [-y] [--progress=<type>] -v=<versionsToUninstall>[, + <versionsToUninstall>…​] [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command removes one or more fcli installations that were previously installed using the 'fcli tool fcli install' command. Note that global bin scripts, if installed, will not be updated or removed by this command. If you un-install the version to which the global bin-script is currently pointing, the global bin script will cease functioning. To update the global bin script to point to an existing version, please use the install command.

+
+
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of fcli.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fcli.html b/v2.10.1/manpage/fcli-tool-fcli.html new file mode 100644 index 000000000..e144a6287 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fcli.html @@ -0,0 +1,101 @@ +--- +title: fcli-tool-fcli(1) +fcli_version: +--- + + + + + + + +fcli-tool-fcli(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fcli [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

For more information about Fortify CLI, please see the source code repository at https://github.com/fortify/fcli. User documentation is available at https://fortify.github.io/fcli/.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install fcli.

+
+
list, ls
+
+

List available and installed fcli versions.

+
+
list-platforms, lsp
+
+

List available platforms for fcli.

+
+
uninstall
+
+

Uninstall fcli.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fod-uploader-install.html b/v2.10.1/manpage/fcli-tool-fod-uploader-install.html new file mode 100644 index 000000000..3e29b4120 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fod-uploader-install.html @@ -0,0 +1,187 @@ +--- +title: fcli-tool-fod-uploader-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-fod-uploader-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fod-uploader install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] + [-v=<version>] [-u=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + [-d=<installDir> | -b=<baseDir>] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fod-uploader-list-platforms.html b/v2.10.1/manpage/fcli-tool-fod-uploader-list-platforms.html new file mode 100644 index 000000000..04afdbabc --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fod-uploader-list-platforms.html @@ -0,0 +1,132 @@ +--- +title: fcli-tool-fod-uploader-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-fod-uploader-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fod-uploader list-platforms [-v=<version>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fod-uploader-list.html b/v2.10.1/manpage/fcli-tool-fod-uploader-list.html new file mode 100644 index 000000000..c84ee3801 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fod-uploader-list.html @@ -0,0 +1,127 @@ +--- +title: fcli-tool-fod-uploader-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-fod-uploader-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fod-uploader list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fod-uploader-uninstall.html b/v2.10.1/manpage/fcli-tool-fod-uploader-uninstall.html new file mode 100644 index 000000000..bf515d008 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fod-uploader-uninstall.html @@ -0,0 +1,140 @@ +--- +title: fcli-tool-fod-uploader-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-fod-uploader-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fod-uploader uninstall [-y] [--progress=<type>] + -v=<versionsToUninstall>[, + <versionsToUninstall>…​] + [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command removes one or more Fortify on Demand Uploader installations that were previously installed using the 'fcli tool fod-uploader install' command. Note that global bin scripts, if installed, will not be updated or removed by this command. If you un-install the version to which the global bin-script is currently pointing, the global bin script will cease functioning. To update the global bin script to point to an existing version, please use the install command.

+
+
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of Fortify on Demand Uploader.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-fod-uploader.html b/v2.10.1/manpage/fcli-tool-fod-uploader.html new file mode 100644 index 000000000..3adb0bfd1 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-fod-uploader.html @@ -0,0 +1,101 @@ +--- +title: fcli-tool-fod-uploader(1) +fcli_version: +--- + + + + + + + +fcli-tool-fod-uploader(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool fod-uploader [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

For more information about FoDUploader, please see the source code repository at https://github.com/fod-dev/fod-uploader-java.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install Fortify on Demand Uploader.

+
+
list, ls
+
+

List available and installed FoD Uploader versions.

+
+
list-platforms, lsp
+
+

List available platforms for FoD Uploader.

+
+
uninstall
+
+

Uninstall Fortify on Demand Uploader.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-sc-client-install.html b/v2.10.1/manpage/fcli-tool-sc-client-install.html new file mode 100644 index 000000000..082dbc595 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-sc-client-install.html @@ -0,0 +1,192 @@ +--- +title: fcli-tool-sc-client-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-sc-client-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool sc-client install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] + [-t=<clientAuthToken>] [-v=<version>] + [-u=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] [-d=<installDir> | + -b=<baseDir>] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-t, --client-auth-token=<clientAuthToken>
+
+

ScanCentral SAST client_auth_token used for authenticating with ScanCentral SAST Controller.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-sc-client-list-platforms.html b/v2.10.1/manpage/fcli-tool-sc-client-list-platforms.html new file mode 100644 index 000000000..506c5029d --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-sc-client-list-platforms.html @@ -0,0 +1,131 @@ +--- +title: fcli-tool-sc-client-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-sc-client-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool sc-client list-platforms [-v=<version>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-sc-client-list.html b/v2.10.1/manpage/fcli-tool-sc-client-list.html new file mode 100644 index 000000000..39336c3f1 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-sc-client-list.html @@ -0,0 +1,127 @@ +--- +title: fcli-tool-sc-client-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-sc-client-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool sc-client list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-sc-client-uninstall.html b/v2.10.1/manpage/fcli-tool-sc-client-uninstall.html new file mode 100644 index 000000000..81ce53238 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-sc-client-uninstall.html @@ -0,0 +1,138 @@ +--- +title: fcli-tool-sc-client-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-sc-client-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool sc-client uninstall [-y] [--progress=<type>] -v=<versionsToUninstall> + [,<versionsToUninstall>…​] + [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command removes one or more Fortify Vulnerability Exporter installations that were previously installed using the 'fcli tool vuln-exporter install' command. Note that global bin scripts, if installed, will not be updated or removed by this command. If you un-install the version to which the global bin-script is currently pointing, the global bin script will cease functioning. To update the global bin script to point to an existing version, please use the install command.

+
+
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of ScanCentral SAST Client.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-sc-client.html b/v2.10.1/manpage/fcli-tool-sc-client.html new file mode 100644 index 000000000..4a204808c --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-sc-client.html @@ -0,0 +1,99 @@ +--- +title: fcli-tool-sc-client(1) +fcli_version: +--- + + + + + + + +fcli-tool-sc-client(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool sc-client [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install ScanCentral SAST Client.

+
+
list, ls
+
+

List available and installed ScanCentral SAST Client versions.

+
+
list-platforms, lsp
+
+

List available platforms for ScanCentral SAST Client.

+
+
uninstall
+
+

Uninstall ScanCentral SAST Client.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-vuln-exporter-install.html b/v2.10.1/manpage/fcli-tool-vuln-exporter-install.html new file mode 100644 index 000000000..c086dbba8 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-vuln-exporter-install.html @@ -0,0 +1,188 @@ +--- +title: fcli-tool-vuln-exporter-install(1) +fcli_version: +--- + + + + + + + +fcli-tool-vuln-exporter-install(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool vuln-exporter install [-y] [--[no-]global-bin] + [--on-digest-mismatch=<onDigestMismatch>] + [-p=<platform>] [--progress=<type>] + [-v=<version>] [-u=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] [-d=<installDir> | + -b=<baseDir>] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

This command allows for tool installation and upgrade. All tools are installed to <base-dir>/<tool-name>/<version>. The base directory can be specified using the --base-dir option, defaulting to <user.home>/fortify/tools if not specified. Unless the --no-global-bin option is specified, wrapper scripts for invoking each tool will be installed to <base-dir>/bin, allowing users to add this directory to the system PATH for easy tool invocations.

+
+
+

When installing a new version, older versions can optionally be automatically un-installed using the --uninstall option, which is basically the equivalent of an upgrade. When trying to install a version that’s already been installed, only some post-installation tasks will be re-run, like installing the global bin scripts and performing any tool configuration if applicable.

+
+
+

Sample invocations:

+
+
+

Install latest tool version, keep older versions: + fcli tool <name> install -v latest

+
+
+

Install latest tool version (only re-running post-install if already existing), uninstall all other tool versions: + fcli tool <name> install -v latest --uninstall all

+
+
+

Install latest v2 version, uninstall all other v2 versions: + fcli tool <name> install -v 2 --uninstall 2

+
+
+

Install latest and latest v1, have global bin-scripts point to latest: + fcli tool <name> install -v latest + fcli tool <name> install -v 1 --no-global-bin

+
+
+
+
+

Options

+
+
+
+
-b, --base-dir=<baseDir>
+
+

Directory under which the tool will be installed. Defaults to ~/fortify. Tools will be installed to <base-dir>/<tool>/<version>.

+
+
-d, --install-dir=<installDir>
+
+

Tool installation directory. Deprecated, use --base-dir instead.

+
+
--[no-]global-bin
+
+

By default, wrapper scripts will be installed to <base-dir>/bin; use --no-global-bin to skip installing/updating these wrapper scripts.

+
+
--on-digest-mismatch=<onDigestMismatch>
+
+

Action to take if there is a digest mismatch. Allowed values: fail, warn. Default action is to fail.

+
+
-p, --platform=<platform>
+
+

By default, fcli will try to install tool binaries that match the current operating system & architecture. Use this option to override automatic platform detection. The list-platforms command lists available platforms.

+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-u, --uninstall=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

Uninstall the given versions while installing the new version. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-v, --version=<version>
+
+

Tool version to install; see output of list command to view available versions. Default value: latest

+
+
-y, --confirm
+
+

Automatically confirm all prompts (cleaning the target directory, uninstalling other versions).

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-vuln-exporter-list-platforms.html b/v2.10.1/manpage/fcli-tool-vuln-exporter-list-platforms.html new file mode 100644 index 000000000..3ebe577aa --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-vuln-exporter-list-platforms.html @@ -0,0 +1,132 @@ +--- +title: fcli-tool-vuln-exporter-list-platforms(1) +fcli_version: +--- + + + + + + + +fcli-tool-vuln-exporter-list-platforms(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool vuln-exporter list-platforms [-v=<version>] [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] + [--to-file=<outputFile>_]] [-q=<SpEL _ + _ expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
-v, --version=<version>
+
+

Tool version for which to list available platforms.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-vuln-exporter-list.html b/v2.10.1/manpage/fcli-tool-vuln-exporter-list.html new file mode 100644 index 000000000..4277727c0 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-vuln-exporter-list.html @@ -0,0 +1,127 @@ +--- +title: fcli-tool-vuln-exporter-list(1) +fcli_version: +--- + + + + + + + +fcli-tool-vuln-exporter-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool vuln-exporter list [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+
+

Use the 'fcli tool definitions update' command to update the list of available versions.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-vuln-exporter-uninstall.html b/v2.10.1/manpage/fcli-tool-vuln-exporter-uninstall.html new file mode 100644 index 000000000..132c76b7d --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-vuln-exporter-uninstall.html @@ -0,0 +1,138 @@ +--- +title: fcli-tool-vuln-exporter-uninstall(1) +fcli_version: +--- + + + + + + + +fcli-tool-vuln-exporter-uninstall(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool vuln-exporter uninstall [-y] [--progress=<type>] + -v=<versionsToUninstall>[, + <versionsToUninstall>…​] + [-v=<versionsToUninstall>[, + <versionsToUninstall>…​]]…​ [[-h] + [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]] ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
--progress=<type>
+
+

Configure progress output. Allowed values: auto, none, simple, stderr, single-line, ansi. Default value: auto. Proper output of single-line and ansi depends on console capabilities.

+
+
-v, --versions=<versionsToUninstall>[,<versionsToUninstall>…​]
+
+

One or more tool version to uninstall. Accepts 'all' to uninstall all existing versions, or a comma-separated list of version numbers. Version numbers may be specified as <major>[.<minor>[.<patch>]].

+
+
-y, --confirm
+
+

Confirm removal of Fortify Vulnerability Exporter.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool-vuln-exporter.html b/v2.10.1/manpage/fcli-tool-vuln-exporter.html new file mode 100644 index 000000000..e52eafc92 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool-vuln-exporter.html @@ -0,0 +1,101 @@ +--- +title: fcli-tool-vuln-exporter(1) +fcli_version: +--- + + + + + + + +fcli-tool-vuln-exporter(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool vuln-exporter [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

For more information about Fortify Vulnerability Exporter, please see the source code repository at https://github.com/fortify/FortifyVulnerabilityExporter.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
install
+
+

Download and install Fortify Vulnerability Exporter.

+
+
list, ls
+
+

List available and installed Fortify Vulnerability Exporter versions.

+
+
list-platforms, lsp
+
+

List available platforms for Fortify Vulnerability Exporter.

+
+
uninstall
+
+

Uninstall Fortify Vulnerability Exporter.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-tool.html b/v2.10.1/manpage/fcli-tool.html new file mode 100644 index 000000000..5485c0390 --- /dev/null +++ b/v2.10.1/manpage/fcli-tool.html @@ -0,0 +1,113 @@ +--- +title: fcli-tool(1) +fcli_version: +--- + + + + + + + +fcli-tool(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli tool [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for installing other Fortify tools like FoD Uploader, ScanCentral Client and FortifyVulnerabilityExporter, and managing those installations.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
bugtracker-utility, fbtu
+
+

Manage FortifyBugTrackerUtility installations.

+
+
debricked-cli, dcli
+
+

Manage Debricked CLI installations.

+
+
fcli
+
+

Manage fcli installations.

+
+
fod-uploader, fodupload
+
+

Manage FoD Uploader installations.

+
+
sc-client, scancentral-client
+
+

Manage ScanCentral SAST Client installations.

+
+
vuln-exporter, fve
+
+

Manage Fortify Vulnerability Exporter installations.

+
+
definitions
+
+

Manage tool definitions.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-all-commands-list.html b/v2.10.1/manpage/fcli-util-all-commands-list.html new file mode 100644 index 000000000..71c77a702 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-all-commands-list.html @@ -0,0 +1,145 @@ +--- +title: fcli-util-all-commands-list(1) +fcli_version: +--- + + + + + + + +fcli-util-all-commands-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util all-commands list [-q=<SpEL expression>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]]

+
+
+
+
+

Description

+
+
+

By default, this command outputs a table listing all available fcli commands. The --query option can be used to output a subset of commands.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true. See the output of '-o json-properties' for the list of properties that you can query on. Common queries include the following:

+
+

-q '!hidden' (only non-hidden commands)

+
+
+

-q 'hidden' (only hidden commands)

+
+
+

-q '!runnable' (only container commands)

+
+
+

-q 'runnable' (only runnable commands)

+
+
+

-q '!hidden && runnable' (only non-hidden, runnable commands)

+
+
+

-q 'module=="config"' (only 'config' commands)

+
+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-all-commands-usage.html b/v2.10.1/manpage/fcli-util-all-commands-usage.html new file mode 100644 index 000000000..2325e11a4 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-all-commands-usage.html @@ -0,0 +1,121 @@ +--- +title: fcli-util-all-commands-usage(1) +fcli_version: +--- + + + + + + + +fcli-util-all-commands-usage(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util all-commands usage [-q=<SpEL expression>] [[-h] + [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]]

+
+
+
+
+

Description

+
+
+

By default, this command outputs the usage information for every individual fcli command, similar to manually invoking each command with the --help option. The --query option can be used to only display usage information for a subset of commands.

+
+
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display usage information for commands that match the given Spring Expression Language (SpEL) expression. See the output of 'fcli util all-commands list -o json-properties' for the list of properties that you can query on. Common queries include the following:

+
+

-q '!hidden' (only non-hidden commands)

+
+
+

-q 'hidden' (only hidden commands)

+
+
+

-q '!runnable' (only container commands)

+
+
+

-q 'runnable' (only runnable commands)

+
+
+

-q '!hidden && runnable' (only non-hidden, runnable commands)

+
+
+

-q 'module=="config"' (only 'config' commands)

+
+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-all-commands.html b/v2.10.1/manpage/fcli-util-all-commands.html new file mode 100644 index 000000000..eb1922b21 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-all-commands.html @@ -0,0 +1,91 @@ +--- +title: fcli-util-all-commands(1) +fcli_version: +--- + + + + + + + +fcli-util-all-commands(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util all-commands [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
usage
+
+

Display usage information for (a subset of) all fcli commands.

+
+
list, ls
+
+

List (a subset of) all fcli commands.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-auto-complete-generate.html b/v2.10.1/manpage/fcli-util-auto-complete-generate.html new file mode 100644 index 000000000..e605dd009 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-auto-complete-generate.html @@ -0,0 +1,91 @@ +--- +title: fcli-util-auto-complete-generate(1) +fcli_version: +--- + + + + + + + +fcli-util-auto-complete-generate(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util auto-complete generate [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] + [--log-level=<logLevel>]]

+
+
+
+
+

Description

+
+
+

Generate bash/zsh completion script for fcli. +Run the following command to give fcli TAB completion in the current shell: + source <(fcli util auto-complete generate)

+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-auto-complete.html b/v2.10.1/manpage/fcli-util-auto-complete.html new file mode 100644 index 000000000..6bf2af328 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-auto-complete.html @@ -0,0 +1,87 @@ +--- +title: fcli-util-auto-complete(1) +fcli_version: +--- + + + + + + + +fcli-util-auto-complete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util auto-complete [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
generate
+
+

Generate fcli auto-completion script.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-crypto-decrypt.html b/v2.10.1/manpage/fcli-util-crypto-decrypt.html new file mode 100644 index 000000000..d861ccf30 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-crypto-decrypt.html @@ -0,0 +1,86 @@ +--- +title: fcli-util-crypto-decrypt(1) +fcli_version: +--- + + + + + + + +fcli-util-crypto-decrypt(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util crypto decrypt [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-crypto-encrypt.html b/v2.10.1/manpage/fcli-util-crypto-encrypt.html new file mode 100644 index 000000000..6a83a9e32 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-crypto-encrypt.html @@ -0,0 +1,86 @@ +--- +title: fcli-util-crypto-encrypt(1) +fcli_version: +--- + + + + + + + +fcli-util-crypto-encrypt(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util crypto encrypt [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]]

+
+
+
+
+

Description

+
+ +
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-crypto.html b/v2.10.1/manpage/fcli-util-crypto.html new file mode 100644 index 000000000..9237fc7f3 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-crypto.html @@ -0,0 +1,94 @@ +--- +title: fcli-util-crypto(1) +fcli_version: +--- + + + + + + + +fcli-util-crypto(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util crypto [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

These commands allow for encrypting and decrypting string values using fcli built-in encryption mechanism and password. The password can be customized through the FCLI_ENCRYPT_KEY environment variable, obviously the same password should be configured during encryption and decryption. +Note that for now, encryption and decryption is not compatible with Fortify’s pwtool utility. These commands are mainly meant to allow encrypted passwords to be stored in fcli configuration files, for example as used by the 'fcli license msp-report' and 'fcli license ncd-report' commands.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
encrypt
+
+

Encrypt a value.

+
+
decrypt
+
+

Decrypt a value.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-state-clear.html b/v2.10.1/manpage/fcli-util-state-clear.html new file mode 100644 index 000000000..dc16a2a03 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-state-clear.html @@ -0,0 +1,126 @@ +--- +title: fcli-util-state-clear(1) +fcli_version: +--- + + + + + + + +fcli-util-state-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util state clear [-y] [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+
+

This command deletes all state data from the fcli data directory. This includes variable data and session data. As a best practice, you should log out of existing sessions before running this command to perform proper session cleanup. This command does not clear fcli configuration data; please use the 'fcli config clear' command for clearing configuration data.

+
+
+
+
+

Options

+
+
+
+
-y, --confirm
+
+

Confirm deleting all fcli state.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-state.html b/v2.10.1/manpage/fcli-util-state.html new file mode 100644 index 000000000..aa623c9c3 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-state.html @@ -0,0 +1,89 @@ +--- +title: fcli-util-state(1) +fcli_version: +--- + + + + + + + +fcli-util-state(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util state [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

The commands in this module allow for managing fcli state, like clearing all state data.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
clear
+
+

Clear all fcli state data.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable-clear.html b/v2.10.1/manpage/fcli-util-variable-clear.html new file mode 100644 index 000000000..add765e25 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable-clear.html @@ -0,0 +1,110 @@ +--- +title: fcli-util-variable-clear(1) +fcli_version: +--- + + + + + + + +fcli-util-variable-clear(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable clear [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]]

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable-contents.html b/v2.10.1/manpage/fcli-util-variable-contents.html new file mode 100644 index 000000000..cac653f11 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable-contents.html @@ -0,0 +1,139 @@ +--- +title: fcli-util-variable-contents(1) +fcli_version: +--- + + + + + + + +fcli-util-variable-contents(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable contents [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + [-q=<SpEL expression>] <variableName>

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<variableName>
+
+

Variable name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable-delete.html b/v2.10.1/manpage/fcli-util-variable-delete.html new file mode 100644 index 000000000..254851783 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable-delete.html @@ -0,0 +1,125 @@ +--- +title: fcli-util-variable-delete(1) +fcli_version: +--- + + + + + + + +fcli-util-variable-delete(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable delete [[-h] [--env-prefix=<envPrefix>] + [--log-file=<logFile>] [--log-level=<logLevel>]] + ] [--store=_variableName[: + _ <propertyNames>]] [--to-file=<outputFile>_]] + <variableName>

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<variableName>
+
+

Variable name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable-get.html b/v2.10.1/manpage/fcli-util-variable-get.html new file mode 100644 index 000000000..2f50ed33b --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable-get.html @@ -0,0 +1,124 @@ +--- +title: fcli-util-variable-get(1) +fcli_version: +--- + + + + + + + +fcli-util-variable-get(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable get [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] <variableName>

+
+
+
+
+

Description

+
+ +
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+

Arguments

+
+
+
+
<variableName>
+
+

Variable name.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable-list.html b/v2.10.1/manpage/fcli-util-variable-list.html new file mode 100644 index 000000000..bab8a3517 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable-list.html @@ -0,0 +1,124 @@ +--- +title: fcli-util-variable-list(1) +fcli_version: +--- + + + + + + + +fcli-util-variable-list(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable list [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] + [--log-level=<logLevel>]] ] + [--store=_variableName[:<propertyNames>]] + [--to-file=<outputFile>]] [-q=<SpEL expression>]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-q, --query=<SpEL expression>
+
+

Only display records for which the given Spring Expression Language (SpEL) expression returns true.

+
+
+
+
+
+
+

Output options

+
+
+
+
-o, --output=format[=<options>]
+
+

Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.

+
+
--store=variableName[:<propertyNames>]
+
+

Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.

+
+
--to-file=<outputFile>
+
+

Write command output to the specified file instead of stdout.

+
+
+
+
+
+
+

Generic fcli options

+
+
+
+
--env-prefix=<envPrefix>
+
+

Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.

+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
--log-file=<logFile>
+
+

File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.

+
+
--log-level=<logLevel>
+
+

Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util-variable.html b/v2.10.1/manpage/fcli-util-variable.html new file mode 100644 index 000000000..e4d9d7090 --- /dev/null +++ b/v2.10.1/manpage/fcli-util-variable.html @@ -0,0 +1,103 @@ +--- +title: fcli-util-variable(1) +fcli_version: +--- + + + + + + + +fcli-util-variable(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util variable [-h] [COMMAND]

+
+
+
+
+

Description

+
+ +
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
contents
+
+

Get fcli variable contents.

+
+
clear
+
+

Clear all fcli variables.

+
+
delete, rm
+
+

Delete a single fcli variable.

+
+
get
+
+

Get fcli variable meta-data.

+
+
list, ls
+
+

List fcli variables.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli-util.html b/v2.10.1/manpage/fcli-util.html new file mode 100644 index 000000000..4d1d93efa --- /dev/null +++ b/v2.10.1/manpage/fcli-util.html @@ -0,0 +1,105 @@ +--- +title: fcli-util(1) +fcli_version: +--- + + + + + + + +fcli-util(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli util [-h] [COMMAND]

+
+
+
+
+

Description

+
+
+

This module provides various utility commands that don’t fit in any of the other fcli modules.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
+
+
+
+
+

Commands

+
+
+
+
all-commands
+
+

List and display help information for all fcli commands.

+
+
auto-complete
+
+

Manage fcli auto-completion scripts.

+
+
crypto
+
+

Encrypt and decrypt data.

+
+
state
+
+

Manage fcli state data.

+
+
variable, var
+
+

Manage fcli variables.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/manpage/fcli.html b/v2.10.1/manpage/fcli.html new file mode 100644 index 000000000..413bbb6f5 --- /dev/null +++ b/v2.10.1/manpage/fcli.html @@ -0,0 +1,127 @@ +--- +title: fcli(1) +fcli_version: fcli version 2.10.1, built on 2024-12-05 13 14 14 +--- + + + + + + + +fcli(1) + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+

Synopsis

+
+
+

fcli [-hV] [COMMAND]

+
+
+
+
+

Description

+
+
+

As the name implies, Fortify CLI (fcli) is a general-purpose command-line utility for working with the various Fortify products.

+
+
+

Fortify CLI is structured using sub-commands, based on the following convention: 'fcli <module> <entity> <action>'. Every sub-command provides its own detailed usage instructions, accessible through the -h or --help option on each sub-command. Where applicable, the usage instructions include the list of sub-commands. For example, the Commands section below displays the sub-commands representing the various fcli modules. A list of all available fcli commands can be obtained through the 'fcli util all-commands list' command.

+
+
+

It is highly recommended to review the fcli user documentation, which both explains general fcli concepts and provides detailed instructions on particular topics like common command line options and use of environment variables and fcli variables. The link to the online documentation can be found at the bottom of the help output for every individual fcli command, as seen below.

+
+
+
+
+

Options

+
+
+
+
-h, --help
+
+

Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.

+
+
-V, --version
+
+

Print version information and exit.

+
+
+
+
+
+
+

Commands

+
+
+
+
config, cfg
+
+

Manage fcli configuration settings (proxy, trust store, …​).

+
+
fod
+
+

Interact with Fortify on Demand (FoD).

+
+
sc-dast
+
+

Interact with Fortify ScanCentral DAST (SC-DAST).

+
+
sc-sast
+
+

Interact with Fortify ScanCentral SAST (SC-SAST).

+
+
ssc
+
+

Interact with Fortify Software Security Center (SSC).

+
+
tool
+
+

Install and manage other Fortify tools and utilities.

+
+
license
+
+

Commands for generating MSP & NCD license reports

+
+
util
+
+

Utility commands that don’t fit in any of the other modules.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/v2.10.1/ssc-actions.html b/v2.10.1/ssc-actions.html new file mode 100644 index 000000000..ee265dd23 --- /dev/null +++ b/v2.10.1/ssc-actions.html @@ -0,0 +1,843 @@ +--- +title: Fcli SSC Actions +fcli_version: 2.10.1 +--- + + + + + + + +Fcli SSC Actions + +{% include asciidoc-head.html %} + + + + +{% include banner.html bannerTitle="FCLI: The Universal Fortify CLI" currentVersion="2.10.1" %} + + + +
+
+
+
+

This manual page describes built-in fcli SSC actions that can be run through +the fcli ssc action run <action-name> command.

+
+
+
+
+

sample

+
+
+

Sample Action

+
+
+

Synopsis

+
+

fcli ssc action run sample [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action documents action syntax to allow users to build their own custom actions. +Note that action syntax is subject to change. Custom action YAML files that work fine +on the current fcli version may not work on either older or newer fcli versions, and +thus may need to be updated when upgrading fcli. Please see this link for details: +https://github.com/fortify/fcli/issues/515

+
+
+
+

Options

+
+
+
--file, -f
+
+

Output file name (or 'stdout' / 'stderr'). Default value: sample.json

+
+
--github-token
+
+

Required GitHub Token. Default value: GITHUB_TOKEN environment variable.

+
+
--github-org, --gho
+
+

GitHub owner/organization for which to list repositories

+
+
+
+
+
+
+
+

appversion-summary

+
+
+

(PREVIEW) Generate application version summary.

+
+
+

Synopsis

+
+

fcli ssc action run appversion-summary [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generates a short summary listing issue counts and other statistics +for a given application version. Based on user feedback on this initial version +of this action, parameters and output of this action may change in the next +couple of fcli releases.

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: stdout

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filtersets, --fs
+
+

Comma-separated list of filter set names, guid’s or 'default' to display in the summary. If not specified, all filter sets will be included.

+
+
+
+
+
+
+
+

aws-sast-report

+
+
+

Generate a AWS Security Hub SAST report listing Fortify SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run aws-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generate a ASFF report to integrate AWS Security Hub, generated reports +then parsed by the lambda function, see: https://github.com/fortify/CloudDevSecOpsTemplates/ +For information on how to create or update findings into AWS Security Hub, see +https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-update-types.html

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional report output file name (or 'stdout' / 'stderr'). Default value: aws-fortify-report.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
--aws-region
+
+

Required AWS region. Default value: AWS_REGION environment variable.

+
+
--aws-account
+
+

Required AWS account id. Default value: AWS_ACCOUNT_ID environment variable.

+
+
+
+
+
+
+
+

bitbucket-sast-report

+
+
+

Generate a BitBucket Code Insights report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run bitbucket-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into BitBucket, see +https://support.atlassian.com/bitbucket-cloud/docs/code-insights/

+
+
+
+

Options

+
+
+
--report-file, -r
+
+

Optional report output file name (or 'stdout' / 'stderr'). Default value: bb-fortify-report.json

+
+
--annotations-file, -a
+
+

Optional annotations output file name (or 'stdout' / 'stderr'). Default value: bb-fortify-annotations.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

check-policy

+
+
+

(SAMPLE) Check security policy.

+
+
+

Synopsis

+
+

fcli ssc action run check-policy [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This sample action demonstrates how to implement a security policy using +fcli actions, returning a non-zero exit code if any of the checks fail.

+
+
+
+

Options

+
+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
+
+
+
+
+
+

github-pr-comment

+
+
+

(PREVIEW) Add GitHub Pull Request review comments.

+
+
+

Synopsis

+
+

fcli ssc action run github-pr-comment [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action adds review comments to a GitHub Pull Request. Currently +this is marked as PREVIEW as we build out this functionality; later +versions may have different behavior and/or require different action +parameters.

+
+
+

The current implementation simply compares current scan results +against previous scan results in the given SSC application version, +listing all new, re-introduced and removed issues in a new PR comment.

+
+
+

For best results, this fcli action should only be run on GitHub +pull_request triggers. Upon PR creation, a new SSC application version +should be created, copying state from the SSC application version that +represents the branch into which the PR will be merged, and a new scan +should be run on the current PR branch before invoking this fcli action.

+
+
+

This will ensure that scan results for the current PR will be +compared against the latest scan results for the target branch +upon PR creation. Optionally, new scans can be run upon PR changes, +creating new PR comments that show the issue delta compared to the +previous scan for this PR.

+
+
+
+

Options

+
+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--analysis-type, -t
+
+

Analysis type for which to list vulnerabilities. Default value: SCA

+
+
--github-token
+
+

Required GitHub Token. Default value: GITHUB_TOKEN environment variable.

+
+
--github-owner
+
+

Required GitHub repository owner. Default value: GITHUB_REPOSITORY_OWNER environment variable.

+
+
--github-repo
+
+

Required GitHub repository. Default value: Taken from GITHUB_REPOSITORY environment variable.

+
+
--pr
+
+

Required PR number. Default value: Taken from GITHUB_REF_NAME environment variable. Note that default value will only work on GitHub pull_request triggers; if this fcli action is invoked through any other GitHub trigger, it will fail unless an explicit PR number is passed through this option.

+
+
--commit
+
+

Required commit hash. Default value: GITHUB_SHA environment variable.

+
+
--dryrun
+
+

Set to true to just output PR decoration JSON; don’t actually update any PR

+
+
+
+
+
+
+
+

github-sast-report

+
+
+

Generate a GitHub Code Scanning report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run github-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitHub, see +https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gh-fortify-sast.sarif

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

gitlab-dast-report

+
+
+

Generate a GitLab DAST report listing SSC DAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run gitlab-dast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdast

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-dast.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

gitlab-debricked-report

+
+
+

Generate a GitLab Dependency Scanning report listing SSC Debricked vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run gitlab-debricked-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdependency_scanning

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-debricked-depscan.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

gitlab-sast-report

+
+
+

Generate a GitLab SAST report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run gitlab-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportssast

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-sast.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

gitlab-sonatype-report

+
+
+

Generate a GitLab Dependency Scanning report listing SSC Sonatype vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run gitlab-sonatype-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into GitLab, see +https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdependency_scanning

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: gl-fortify-sonatype-depscan.json

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

sarif-sast-report

+
+
+

Generate SARIF report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run sarif-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action generates a SARIF report listing Fortify SAST vulnerabilities, which +may be useful for integration with various 3rd-party tools that can ingest SARIF +reports. For more information about SARIF, please see +https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: fortify-sast.sarif

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+

setup-appversion

+
+
+

Set up application version.

+
+
+

Synopsis

+
+

fcli ssc action run setup-appversion [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

This action allows for preparing an application version for running an application +security scan, creating the application and/or release if they do not exist yet.

+
+
+

Although the same functionality can be achieved by manually running the +fcli ssc appversion create command, this action provides a convenient and +standardized approach for running this command with some default options like +--skip-if-exists and --auto-required-attrs.

+
+
+

To provide even more consistency across CI/CD pipelines in your organization, it +is recommended to implement one or more custom setup actions that provide suitable +default values or even hard-coded, non-overridable values for the various options, +for example based on business unit, team, and/or application type. Such custom +actions could for example set standard application version attributes for a +particular type of application to be scanned. Alternative to implementing multiple +custom actions, you may also consider implementing a single custom action that takes +for example a --profile option to select between different profiles that each define +appropriate option values and setup commands to run.

+
+
+
+

Options

+
+
+
--appversion, --av
+
+

Required application version name as <appName>:<versionName>

+
+
--add-users
+
+

See fcli ssc appversion create

+
+
--attrs, --attributes
+
+

See fcli ssc appversion create

+
+
--copy
+
+

See fcli ssc appversion create

+
+
--description, -d
+
+

See fcli ssc appversion create

+
+
--copy-from, --from
+
+

See fcli ssc appversion create

+
+
--issue-template
+
+

See fcli ssc appversion create

+
+
--refresh-timeout
+
+

See 'fcli ssc av create'. Default value: 300s

+
+
+
+
+
+
+
+

sonarqube-sast-report

+
+
+

Generate a SonarQube External Issues report listing SSC SAST vulnerabilities.

+
+
+

Synopsis

+
+

fcli ssc action run sonarqube-sast-report [fcli ssc action run options] [action options, see below]

+
+
+
+

Description

+
+

For information on how to import this report into SonarQube, see +https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/importing-external-issues/external-analyzer-reports/

+
+
+
+

Options

+
+
+
--file, -f
+
+

Optional output file name (or 'stdout' / 'stderr'). Default value: sq-fortify-sast.json

+
+
--file-path-prefix, --pfx
+
+

Optional prefix for issue file paths

+
+
--appversion, --av
+
+

Required application version id or <appName>:<versionName>

+
+
--filterset, --fs
+
+

Optional filter set name or guid from which to load issue data. Default value: Default filter set for given application version

+
+
--page-size
+
+

Number of vulnerabilities to retrieve at a time. Higher numbers may reduce time required to build the report, at the cost of increased memory usage (on both fcli and SSC), and could potentially negatively affect overall SSC performance or result in read time-outs (see --socket-timeout option on fcli ssc session login command). Default value: 100

+
+
+
+
+
+
+
+ + + \ No newline at end of file