Set Variable Value in Otter

Updated on 14 May 2021
1 Minute to read

Print
Dark

Light
PDF

This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.

Set Variable Value in Otter

Creates or assigns a configuration variable in Otter.

Script usage:

Otter::Set-Variable(
	[Credentials: <text>],
	Name: <text>,
	Value: <text>,
	[Server: <text>],
	[Role: <text>],
	[Environment: <text>],
	[Sensitive: <true/false>],
	[Host: <text>],
	[ApiKey: <SecureString>]
);

Arguments:

Name	Format	Script Usage	Usage Notes
Credentials	text	Credentials
☆ Variable name	text	Name	This argument is required.
☆ Value	text	Value	This argument is required.
Server name	text	Server
Role name	text	Role
Environment name	text	Environment
Sensitive	true/false	Sensitive
Otter server URL	text	Host
API key	SecureString	ApiKey

Note: If multiple entity scopes are provided, the variable will be multi-scoped. If no entity scope is provided, a global variable will be set.

Example:

# sets the variable for the hdars-web-1k-tokyo server to the name of the current application
Otter::Set-Variable
(
    Credentials: ProductionOtter,
    Server: hdars-web-1k-tokyo,
    Name: LatestDeployedApplication,
    Value: $ApplicationName,
    Sensitive: false
);

Was this article helpful?

What's Next

Ensure DSC Resource

Table of contents

Set Variable Value in Otter

Windows-first DevOps Tools.

Products

Company

Support

My Inedo