Skip to content

Latest commit

 

History

History
265 lines (208 loc) · 5.29 KB

Update-SteamServer.md

File metadata and controls

265 lines (208 loc) · 5.29 KB
Raw
external help file Module Name online version schema
SteamPS-help.xml
SteamPS
2.0.0

Update-SteamServer

SYNOPSIS

Update a Steam based game server.

SYNTAX

Update-SteamServer [-AppID] <Int32> [-ServiceName] <String> [-IPAddress] <IPAddress> [-Port] <Int32>
 [[-Path] <String>] [[-Credential] <PSCredential>] [[-Arguments] <String>] [[-LogPath] <String>]
 [[-DiscordWebhookUri] <String>] [[-AlwaysNotify] <String>] [[-TimeoutLimit] <Int32>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet presents a workflow to keep a steam based game server up to date. The server is expecting the game server to be running as a Windows Service.

EXAMPLES

EXAMPLE 1

Update-SteamServer -AppID 476400 -ServiceName GB-PG10 -IPAddress '185.15.73.207' -Port 27015

PARAMETERS

-AlwaysNotify

Always receive a notification when a server has been updated. Default is only to send on errors.

Type: String
Parameter Sets: (All)
Aliases:

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

-AppID

Enter the application ID you wish to install.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Arguments

Enter any additional arguments here.

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

If the app requires login to install or update, enter your Steam username and password.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

-DiscordWebhookUri

Enter a Discord Webhook Uri if you wish to get notifications about the server update.

Type: String
Parameter Sets: (All)
Aliases:

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

-IPAddress

Enter the IP address of the Steam based server.

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-LogPath

Specify the directory of the log files.

Type: String
Parameter Sets: (All)
Aliases: LogLocation

Required: False
Position: 8
Default value: C:\DedicatedServers\Logs
Accept pipeline input: False
Accept wildcard characters: False

-Path

Install location of the game server.

Type: String
Parameter Sets: (All)
Aliases: ApplicationPath

Required: False
Position: 5
Default value: "C:\DedicatedServers\$ServiceName"
Accept pipeline input: False
Accept wildcard characters: False

-Port

Enter the port number of the Steam based server.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-ServiceName

Specify the Windows Service Name. You can get a list of services with Get-Service.

Type: String
Parameter Sets: (All)
Aliases:

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

-TimeoutLimit

Number of times the cmdlet checks if the server is online or offline. When the limit is reached an error is thrown.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: 10
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

-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

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

Author: Frederik Hjorslev Nylander

RELATED LINKS

https://hjorslev.github.io/SteamPS/Update-SteamServer.html