Skip to content

Set-B1Service

SYNOPSIS

Updates an existing NIOS-X Service

SYNTAX

Default

Set-B1Service [-Name <String>] [-NewName <String>] [-Description <String>] [-Server <String>] [-Tags <Object>]
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Pipeline

Set-B1Service [-NewName <String>] [-Description <String>] [-Server <String>] [-Tags <Object>] -Object <Object>
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function is used to update an existing NIOS-X Service

EXAMPLES

EXAMPLE 1

Set-B1Service -Name "DNS_MyServer" -Description "This is my new description" -Tags @{"tag1"="value1";"tag2"="value2"}

EXAMPLE 2

Get-B1Service -Name "DNS_MyServer" | Set-B1Service -NewName "DNS_MyServer"

PARAMETERS

-Name

The name of the NIOS-X Service to update.

Type: String
Parameter Sets: Default
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewName

Use -NewName to update the name of the NIOS-X Service

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

The description of the NIOS-X Service

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Server

The name of the NIOS-X Host to assign the service to

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tags

A list of tags to apply to this Service. This will overwrite existing tags.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Object

The service object to update. Accepts pipeline input from Get-B1Service

Type: Object
Parameter Sets: Pipeline
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to High.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES