external help file: ZabbixTools-help.xml Module Name: ZabbixTools online version: http://poshzabbixtools.readthedocs.io/en/latest/en-US/Connect-ZabbixServer/ schema: 2.0.0

---

Connect-ZabbixServer

SYNOPSIS

Sends a login request to a Zabbix server API service.

SYNTAX

Uri

Connect-ZabbixServer -Uri <String> -Credential <PSCredential> [-Certificate <Object>] [<CommonParameters>]

Server

Connect-ZabbixServer -Server <String> [-Secure] -Credential <PSCredential> [-Certificate <Object>]
 [<CommonParameters>]

DESCRIPTION

The Connect-ZabbixServer cmdlet retreives the Api authentication key for the session using the credentials provided.

EXAMPLES

EXAMPLE 1

Connect-ZabbixServer -Server 'myserver' -Credential 'myuser'

Connect to the Zabbix server 'myserver' with the username 'myuser'. The connection URI will be 'http://myserver/zabbix/api_jsonrpc.php'.

EXAMPLE 2

Connect-ZabbixServer -Uri 'http://myserver/zabbix/api_jsonrpc.php' -Credential 'Username'

EXAMPLE 3

Connect-ZabbixServer -Uri 'http://myserver/zabbix/api_jsonrpc.php' -Credential (Get-Credential)

PARAMETERS

-Uri

Specifies the Uniform Resource Identifier (URI) of the Internet resource to which the web request is sent. This parameter supports HTTP and HTTPS values.

Type: String
Parameter Sets: Uri
Aliases:

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

-Server

Specifies the name of the Zabbix server to utilize in contrusting the connection URI. If not using the default Zabbix configuration, please specify the full URI using the -Uri paramter.

Type: String
Parameter Sets: Server
Aliases:

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

-Secure

Specifies using HTTPS when the -Server parameter is specified.

Type: SwitchParameter
Parameter Sets: Server
Aliases:

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

-Credential

Specifies a user account that has permission to send the request. The default is the current user.

Type a user name, such as "User01" or "Domain\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-Certificate

{{Fill Certificate Description}}

Type: Object
Parameter Sets: (All)
Aliases:

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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

This function provides no outputs.

NOTES

Author: Trent Willingham Check out my other scripts and projects @ https://github.com/twillin912

RELATED LINKS

http://poshzabbixtools.readthedocs.io/en/latest/en-US/Connect-ZabbixServer/