< Back
Get-OctopusVariableSet
Post
NAME Get-OctopusVariableSet
SYNOPSIS
Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is
the name of the object that holds the collection of variables for both Projects and Library Sets.
Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is
the name of the object that holds the collection of variables for both Projects and Library Sets.
SYNTAX
Get-OctopusVariableSet [[-LibrarySetName] <string[]>] [[-ProjectName] <string[]>] [-IncludeUsage
<SwitchParameter>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-LibrarySetName <string[]>
Library Set name
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ProjectName <string[]>
Project name
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-IncludeUsage <SwitchParameter>
If set to TRUE the list of Projects on which each Library Variable Set is being used will be displayer
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ResourceOnly <SwitchParameter>
If set to TRUE the cmdlet will return the basic Octopus resource. If not set or set to FALSE, the cmdlet will
return a human friendly Octoposh output object
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String[]
Library Set name
System.String[]
Project name
OUTPUTS
System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusVariableSet, Octoposh, Version=1.0.0.0,
Culture=neutral, PublicKeyToken=null]]
System.Collections.Generic.List`1[[Octopus.Client.Model.VariableSetResource, Octopus.Client, Version=4.22.0.0,
Culture=neutral, PublicKeyToken=null]]
---------- EXAMPLE 1 ----------
PS C:\\> Get-OctopusVariableSet
Gets all the Project and Library variable sets of the instance
---------- EXAMPLE 2 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC"
Gets the Variable Set of the Library Variable Set with the name "Stands_SC"
---------- EXAMPLE 3 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC" -IncludeUsage
Gets the Variable Set of the Library Variable Set "Stands_SC" and it also populates the output object property
"Usage" with the list of projects that are currently using the set
---------- EXAMPLE 4 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC","Stands_DII"
Gets the LibraryVariableSets with the names "Stands_SC" and "Stands_DII"
---------- EXAMPLE 5 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_*"
Gets all the LibraryVariableSets whose name matches the pattern "Stands_*"
---------- EXAMPLE 6 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_*" -IncludeLibrarySetUsage
Gets all the LibraryVariableSets whose name matches the pattern "Stands_*". Each result will also include a list
of Projects on which they are being used
---------- EXAMPLE 7 ----------
PS C:\\> Get-OctopusVariableSet -ProjectName "Website_Stardust","Website_Diamond"
Gets the Variable Sets of the Projects "Website_Stardust" and "Website_Diamond"
---------- EXAMPLE 8 ----------
PS C:\\> Get-OctopusVariableSet -ProjectName "Website_Stardust" -LibrarySetName "Stands_SC"
Gets the Variable Sets of the Project "Website_Stardust" and the Library variable set "Stands_SC"
RELATED LINKS
WebSite: http://Octoposh.net
Github Project: https://github.com/Dalmirog/OctoPosh/
Wiki: http://octoposh.readthedocs.io
QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial
SYNOPSIS
Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is
the name of the object that holds the collection of variables for both Projects and Library Sets.
Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is
the name of the object that holds the collection of variables for both Projects and Library Sets.
SYNTAX
Get-OctopusVariableSet [[-LibrarySetName] <string[]>] [[-ProjectName] <string[]>] [-IncludeUsage
<SwitchParameter>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-LibrarySetName <string[]>
Library Set name
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ProjectName <string[]>
Project name
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-IncludeUsage <SwitchParameter>
If set to TRUE the list of Projects on which each Library Variable Set is being used will be displayer
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ResourceOnly <SwitchParameter>
If set to TRUE the cmdlet will return the basic Octopus resource. If not set or set to FALSE, the cmdlet will
return a human friendly Octoposh output object
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String[]
Library Set name
System.String[]
Project name
OUTPUTS
System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusVariableSet, Octoposh, Version=1.0.0.0,
Culture=neutral, PublicKeyToken=null]]
System.Collections.Generic.List`1[[Octopus.Client.Model.VariableSetResource, Octopus.Client, Version=4.22.0.0,
Culture=neutral, PublicKeyToken=null]]
---------- EXAMPLE 1 ----------
PS C:\\> Get-OctopusVariableSet
Gets all the Project and Library variable sets of the instance
---------- EXAMPLE 2 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC"
Gets the Variable Set of the Library Variable Set with the name "Stands_SC"
---------- EXAMPLE 3 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC" -IncludeUsage
Gets the Variable Set of the Library Variable Set "Stands_SC" and it also populates the output object property
"Usage" with the list of projects that are currently using the set
---------- EXAMPLE 4 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_SC","Stands_DII"
Gets the LibraryVariableSets with the names "Stands_SC" and "Stands_DII"
---------- EXAMPLE 5 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_*"
Gets all the LibraryVariableSets whose name matches the pattern "Stands_*"
---------- EXAMPLE 6 ----------
PS C:\\> Get-OctopusVariableSet -LibrarySetName "Stands_*" -IncludeLibrarySetUsage
Gets all the LibraryVariableSets whose name matches the pattern "Stands_*". Each result will also include a list
of Projects on which they are being used
---------- EXAMPLE 7 ----------
PS C:\\> Get-OctopusVariableSet -ProjectName "Website_Stardust","Website_Diamond"
Gets the Variable Sets of the Projects "Website_Stardust" and "Website_Diamond"
---------- EXAMPLE 8 ----------
PS C:\\> Get-OctopusVariableSet -ProjectName "Website_Stardust" -LibrarySetName "Stands_SC"
Gets the Variable Sets of the Project "Website_Stardust" and the Library variable set "Stands_SC"
RELATED LINKS
WebSite: http://Octoposh.net
Github Project: https://github.com/Dalmirog/OctoPosh/
Wiki: http://octoposh.readthedocs.io
QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial