On this page

    Set-ServerConfiguration

    SYNOPSIS

    Updates a stores Server entry.

    SYNTAX

    Set-AtlassianServerConfiguration [-Id] <UInt32> [[-Uri] <Uri>]
 [[-Name] <String>] [-Type] <ServerType> [[-Session] <WebRequestSession>]
 [[-Headers] <Hashtable>] [<CommonParameters>]

    DESCRIPTION

    This function provides the means to change a stored server entry.

    EXAMPLES

    EXAMPLE 1

    Add-AtlassianServerConfiguration -Uri "https://server.com/" -Type "Confluence"
Set-AtlassianServerConfiguration -Id 1 -Uri "https://atlassian.net"

    This command will replace the Uri stored of the first entry of the stored servers.

    EXAMPLE 2

    Add-AtlassianServerConfiguration -Name "My Server" -Uri "https://server.com/" -Type "Jira"
Set-AtlassianServerConfiguration -Id 1 -Name "wiki" -Type "Confluence"

    This command will replace the Name and Type of the first entry of the stored servers.

    EXAMPLE 3

    Add-AtlassianServerConfiguration -Name "JiraServer" -Uri "https://server.com/" -Type "Jira"
Get-AtlassianServerConfiguration |
    Where Type -eq "JIRA" |
    Set-AtlassianServerConfiguration -Uri "https://atlassian.net"

    This command will replace the Uri of all stored Jira servers with the new address.

    PARAMETERS

    -Id

    Identifier (index) of the entry to update

    Type: UInt32
Parameter Sets: (All)
Aliases:

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

    -Uri

    Address of the Server.

    Type: Uri
Parameter Sets: (All)
Aliases: Url, Address

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

    -Name

    Name with which this server will be stored.

    If no name is provided, the “Authority” of the address will be used. This value must be unique.

    In case the ServerName was already saved, it will be overwritten.

    Example for “Authority”: https://www.google.com/maps?hl=en –> “www.google.com”

    Is not case sensitive

    Type: String
Parameter Sets: (All)
Aliases: ServerName, Alias

Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

    -Type

    Type of the server to store.

    This can be:

    • Bitbucket
    • Confluence
    • Jira
    Type: ServerType
Parameter Sets: (All)
Aliases:
Accepted values: BITBUCKET, CONFLUENCE, JIRA

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

    -Session

    Stores a WebSession to the server object.

    Type: WebRequestSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

    -Headers

    Stores the Headers that should be used for this server

    Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

    INPUTS

    OUTPUTS

    NOTES

    AtlassianPS.ServerData

    Get-ServerConfiguration

    Remove-ServerConfiguration

    Export-Configuration