Skip to content

Latest commit

 

History

History
202 lines (150 loc) · 5.33 KB

File metadata and controls

202 lines (150 loc) · 5.33 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Initialize-IntersightSyslogRemoteClientBase

SYNOPSIS

Fill in the Synopsis

SYNTAX


Initialize-IntersightSyslogRemoteClientBase [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][[-ClassId]< SyslogRemoteClientBase.ClassIdEnum>][-Enabled< bool>][-Hostname< string>][-MinSeverity< SyslogRemoteClientBase.MinSeverityEnum>][[-ObjectType]< SyslogRemoteClientBase.ObjectTypeEnum>][-Port< long>][-Protocol< SyslogRemoteClientBase.ProtocolEnum>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Initialize cmdlet is used to instantiate the object of complex type in the Powershell session, it does not create the object on the server.

PARAMETERS

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

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

-ClassId

The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.

Type: SyslogRemoteClientBase.ClassIdEnum
Parameter Sets: (All)
Aliases:

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

-Enabled

Enables/disables remote logging for the endpoint If enabled, log messages will be sent to the syslog server mentioned in the Hostname/IP Address field.

Type: bool
Parameter Sets: (All)
Aliases:

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

-Hostname

Hostname or IP Address of the syslog server where log should be stored.

Type: string
Parameter Sets: (All)
Aliases:

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

-MinSeverity

Lowest level of messages to be included in the remote log.\n* warning - Use logging level warning for logs classified as warning.\n* emergency - Use logging level emergency for logs classified as emergency.\n* alert - Use logging level alert for logs classified as alert.\n* critical - Use logging level critical for logs classified as critical.\n* error - Use logging level error for logs classified as error.\n* notice - Use logging level notice for logs classified as notice.\n* informational - Use logging level informational for logs classified as informational.\n* debug - Use logging level debug for logs classified as debug.

Type: SyslogRemoteClientBase.MinSeverityEnum
Parameter Sets: (All)
Aliases:

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

-ObjectType

The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.

Type: SyslogRemoteClientBase.ObjectTypeEnum
Parameter Sets: (All)
Aliases:

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

-Port

Port number used for logging on syslog server.

Type: long
Parameter Sets: (All)
Aliases:

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

-Protocol

Transport layer protocol for transmission of log messages to syslog server.\n* udp - Use User Datagram Protocol (UDP) for syslog remote server connection.\n* tcp - Use Transmission Control Protocol (TCP) for syslog remote server connection.

Type: SyslogRemoteClientBase.ProtocolEnum
Parameter Sets: (All)
Aliases:

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

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True 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.

EXAMPLES

Example 1

PS C:\> Initialize-IntersightSyslogRemoteClientBase

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS