Redgate Monitor 14

Creates a new temporary object that holds information about a PostgreSql instance.

Syntax

New-RedgateMonitorPostgreSql -FullName <string> -BaseMonitor <BaseMonitor> -UserName <string> -Password <string> -Port <int> [-LoginDatabase <string>] [-Alias <string>] [<CommonParameters>]

New-RedgateMonitorPostgreSql -FullName <string> -BaseMonitor <BaseMonitor> -UserName <string> -IamAccessKey <string> -IamSecretKey <string> -Port <int> [-LoginDatabase <string>] [-IamRegion <string>] [-Alias <string>] [<CommonParameters>]

New-RedgateMonitorPostgreSql -FullName <string> -BaseMonitor <BaseMonitor> -UserName <string> -IamRoleInstanceProfile -Port <int> [-LoginDatabase <string>] [-IamRegion <string>] [-Alias <string>] [<CommonParameters>]

New-RedgateMonitorPostgreSql -FullName <string> -BaseMonitor <BaseMonitor> -UserName <string> -IamRoleIdentifier <string> -Port <int> [-LoginDatabase <string>] [-IamRegion <string>] [-Alias <string>] [<CommonParameters>]

Description

The New-RedgateMonitorPostgreSql cmdlet creates a new temporary object that holds information about a PostgreSql instance. The returned object needs to be passed to Add-RedgateMonitorMonitoredObject together with a host info, as it does not add anything to Redgate Monitor on its own.

Parameters

`-FullName <String>`

The address of the monitored object e.g. "localhost", or "sample.id.us-east1.rds.amazonaws.com".

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	True (ByValue)
Accept Wildcard Characters	false

`-BaseMonitor <BaseMonitor>`

The base monitor to add the monitored object to. For more informatiom, see https://documentation.red-gate.com/monitor14/api/powershell-api/powershell-cmdlet-reference/get-redgatemonitorbasemonitor.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-UserName <String>`

Database login username to connect to PostgreSQL instance with.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Password <String>`

Database login password to connect to PostgreSQL instance with.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-LoginDatabase <String>`

The database to connect to. This defaults to the username when empty.

Aliases	None
Required?	false
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-IamRegion <String>`

The cloud region that the instance is located.

Aliases	None
Required?	false
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-IamAccessKey <String>`

The access key for an IAM user with permissions to connect to the PostgreSQL instance.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-IamSecretKey <String>`

The secret key for an IAM user with permissions to connect to the PostgreSQL instance.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-IamRoleIdentifier <String>`

The identifier (ARN) of an IAM role with permissions to connect to the PostgreSQL instance. Defaults to the IAM role associated with the instance if blank.

Aliases	None
Required?	true
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-IamRoleInstanceProfile <SwitchParameter>`

Determines if the Base Monitor's EC2 instance profile (attached role) should be used as the IAM role to connect to the PostgreSQL instance.

Aliases	None
Required?	true
Position?	named
Default Value	False
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Alias <String>`

Alias (display name)

Aliases	None
Required?	false
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Port <Int32>`

PostgreSql port number.

Aliases	None
Required?	true
Position?	named
Default Value	0
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ProgressAction <ActionPreference>`

Aliases	None
Required?	false
Position?	named
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`<CommonParameters>`

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None.
You cannot pipe input to this cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

$instance = New-RedgateMonitorPostgreSql -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "pg_username" -Password "pg_pass" -Port 5432
$server = New-RedgateMonitorLinuxHost -HostName "localhost" -BaseMonitor $BaseMonitor -SshUserName "ssh_user" -SshPassword "ssh_pass"
$server, $instance | Add-RedgateMonitorMonitoredObject