IProfInfoUpdatePropOpts | Zowe Node.js SDK

Required options to update any property from the ProfileInfo class.

Index

forceUpdate: boolean

Force the update to the profile specified even if the property comes from somewhere else

example: Token Value could be in the base profile (not in the service profile specified) and the programmer has the intention of storing the token in the service profile
default: false When the property is not specified, the updateProperty method follows current procedure of updating the property in the known jsonLoc (e.g. base profile). Otherwise, the updateProperty method updates the specified profile name-type combination.

profileName: string

Name of the active profile

profileType: string | null

Type of the active profile. Specify null to update a typeless profile.

property: string

Property to update

setSecure: boolean

Specifies if the property should be stored securely or not

value: IProfArgValue | undefined

Value to use when updating the given property