Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICliILoadProfile

Profile Manager "loadProfile" input parameters. Indicates which profile to load (named or default) and if not finding the profile should be considered and error, etc.

export
deprecated
  • Use ICliLoadProfile instead because it is spelled correctly
interface

ICliILoadProfile

Hierarchy

Index

Properties

Optional failNotFound

failNotFound: boolean

Under "normal" circumstances, attempting to load a non-existant profile is an error, however, you may indicate that the profile manager should treat this as a "soft" failure, meaning the promise for the load API will be fulfilled - with the appropriate status message and no profile.

memberof

ILoadProfile

Optional loadDefault

loadDefault: boolean

Load the default profile for the "type" specified in the profile manager instance - if specified, "name" is ignored.

memberof

ILoadProfile

Optional loadDependencies

loadDependencies: boolean

Profiles can have dependencies. Specify "false" if you want to avoid loading the dependencies of this profile. True is the default.

memberof

ILoadProfile

Optional name

name: string

The name of the profile to load - ignored if "loadDefault" is true - the type is indicated by the instance of the instantiated profile manager.

memberof

ILoadProfile

Optional noSecure

noSecure: boolean

If true, fields that indicate "secure" are not loaded. The properties will still be present in the profiles loaded with a value of "securely_stored".

memberof

ILoadProfile

Generated using TypeDoc