< Back
New-BMServerRole
Post
NAME New-BMServerRole
SYNOPSIS
Creates a new server role in a BuildMaster instance.
SYNTAX
New-BMServerRole [-Session] <Object> [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The `New-BMServerRole` creates a new server role in BuildMaster. Pass the name of the role to the `Name`
parameter. Names may only contain letters, numbers, spaces, periods, underscores, or dashes.
Every role must have a unique name. If you create a role with a duplicate name, you'll get an error.
This function uses BuildMaster's infrastructure management API.
Pass a session object representing the instance of BuildMaster to use to the `Session` parameter. Use the
`New-BMSession` function to create session objects.
PARAMETERS
-Session <Object>
An object representing the instance of BuildMaster to connect to. Use `New-BMSession` to create session
objects.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the server role to create.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-BMServerRole -Session $session -Name 'My Role'
Demonstrates how to create a new server role.
RELATED LINKS
SYNOPSIS
Creates a new server role in a BuildMaster instance.
SYNTAX
New-BMServerRole [-Session] <Object> [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The `New-BMServerRole` creates a new server role in BuildMaster. Pass the name of the role to the `Name`
parameter. Names may only contain letters, numbers, spaces, periods, underscores, or dashes.
Every role must have a unique name. If you create a role with a duplicate name, you'll get an error.
This function uses BuildMaster's infrastructure management API.
Pass a session object representing the instance of BuildMaster to use to the `Session` parameter. Use the
`New-BMSession` function to create session objects.
PARAMETERS
-Session <Object>
An object representing the instance of BuildMaster to connect to. Use `New-BMSession` to create session
objects.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the server role to create.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-BMServerRole -Session $session -Name 'My Role'
Demonstrates how to create a new server role.
RELATED LINKS