psCheckPoint.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>psCheckPoint</name> </assembly> <members> <member name="T:psCheckPoint.Objects.Host.RemoveCheckPointHostInterface"> <api cmd="set-host">Set-CheckPointHost</api> <summary> <para type="synopsis">Remove host interface.</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.RemoveCheckPointHostInterface.Host"> <summary> <para type="description">Host object (Name, UID or Host Object)</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.RemoveCheckPointHostInterface.Name"> <summary> <para type="description">Interface name.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.NewCheckPointHostInterface"> <api cmd="set-host">Set-CheckPointHost</api> <summary> <para type="synopsis">Create new host interface.</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.Host"> <summary> <para type="description">Host object (Name, UID or Host Object)</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.Name"> <summary> <para type="description">Interface name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.Subnet4"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.Subnet6"> <summary> <para type="description">IPv6 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.MaskLength4"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.MaskLength6"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHostInterface.Color"> <summary> <para type="description">Color of the object. Should be one of existing colors.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.SetCheckPointHost"> <api cmd="set-host">Set-CheckPointHost</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Set-CheckPointHost -Name Test1 -NewName Test2 -Tags TestTag</code> </example> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.IPAddress"> <summary> <para type="description">IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.IPv4Address"> <summary> <para type="description">IPv4 address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.IPv6Address"> <summary> <para type="description">IPv6 address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.SetCheckPointHost.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.RemoveCheckPointHost"> <api cmd="delete-host">Remove-CheckPointHost</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointHost -Name Test1 -Verbose</code> </example> </member> <member name="P:psCheckPoint.Objects.Host.RemoveCheckPointHost.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.CheckPointHost"> <summary> <para type="description">Details of a Check Point Host</para> </summary> </member> <member name="M:psCheckPoint.Objects.Host.CheckPointHost.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.String,System.String)"> <summary> JSON Constructor for Host </summary> </member> <member name="P:psCheckPoint.Objects.Host.CheckPointHost.Interfaces"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.CheckPointHost.Groups"> <summary> <para type="description">Host interfaces.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.CheckPointHost.IPv4Address"> <summary> <para type="description">IPv4 host address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.CheckPointHost.IPv6Address"> <summary> <para type="description">IPv6 host address.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Host.CheckPointHost.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.Host.CheckPointHost.Interface"> <summary> <para type="description">Details of a Check Point Host Interface</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.GetCheckPointHosts"> <api cmd="show-hosts">Get-CheckPointHosts</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointHosts</code> </example> </member> <member name="P:psCheckPoint.Objects.Host.GetCheckPointHosts.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.GetCheckPointHost"> <api cmd="show-host">Get-CheckPointHost</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>$cpHost = Get-CheckPointHost -Name Test1</code> </example> </member> <member name="P:psCheckPoint.Objects.Host.GetCheckPointHost.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Host.NewCheckPointHost"> <api cmd="add-host">New-CheckPointHost</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code>New-CheckPointHost -Name Test1 -ipAddress 1.2.3.4</code> </example> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.IPAddress"> <summary> <para type="description">IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.IPv4Address"> <summary> <para type="description">IPv4 address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.IPv6Address"> <summary> <para type="description">IPv6 address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.WaitCheckPointTask"> <extra category="Misc.">Wait-CheckPointTask</extra> <summary> <para type="synopsis">Waits for task to complete.</para> <para type="description">Waits for task to complete then returns the completed task details.</para> </summary> <example> <code>Install-CheckPointPolicy -PolicyPackage Standard -Targets MyGateway | Wait-CheckPointTask -Verbose</code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.WaitCheckPointTask.SleepTime"> <summary> <para type="description">Time in seconds to sleep in-between checking task status</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.WaitCheckPointTask.Timeout"> <summary> <para type="description">Timeout in seconds.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.CheckPointWhereUsed"> <summary> <para type="description">Summary of Where Used results</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsed.#ctor(psCheckPoint.Objects.Misc.CheckPointWhereUsedResults,psCheckPoint.Objects.Misc.CheckPointWhereUsedResults)"> <summary> JSON Constructor for Where Used Results Summary </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsed.UsedDirectly"> <summary> <para type="description">Summary of Where Used Directly results</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsed.UsedIndirectly"> <summary> <para type="description">Summary of Where Used Indirectly results</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults"> <summary> <para type="description">Summary of Where Used Result Details</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.#ctor(System.Int32,psCheckPoint.Objects.CheckPointObject[],psCheckPoint.Objects.Misc.CheckPointWhereUsedRule[],psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT[],psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule[])"> <summary> JSON Constructor for Where Used Result Details </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.Total"> <summary> <para type="description">Total results found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.Objects"> <summary> <para type="description">Summary of Check Point Objects found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.AccessControlRules"> <summary> <para type="description">Summary of Access Control Rules found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.NATRules"> <summary> <para type="description">Summary of NATs found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedResults.ThreatPreventionRules"> <summary> <para type="description">Summary of Threat Prevention Rules found</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule"> <summary> <para type="description">Summary of Where Used Rule results</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.#ctor(psCheckPoint.Objects.CheckPointObject,System.String[],System.Int32,psCheckPoint.Objects.CheckPointObject)"> <summary> JSON Constructor for Where Used Rule Results </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.Rule"> <summary> <para type="description">Summary of Access Control Rule found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.RuleColumns"> <summary> <para type="description">Columns where object is used in rule.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.Position"> <summary> <para type="description">Rule position</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.Layer"> <summary> <para type="description">Summary of Layer rule exists in.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.Type"> <summary> <para type="description">Summary object type</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full Access Rule object</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedRule.ToFullObj``1(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full Access Rule object</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT"> <summary> <para type="description">Summary of Where Used NAT results</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.#ctor(psCheckPoint.Objects.CheckPointObject,System.String[],System.String,psCheckPoint.Objects.CheckPointObject)"> <summary> JSON Constructor for Where Used NAT Results </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.Rule"> <summary> <para type="description">Summary of NAT Rule found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.RuleColumns"> <summary> <para type="description">Columns where object is used in rule.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.Position"> <summary> <para type="description">Rule position</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.Package"> <summary> <para type="description">Summary of Package NAT rule exists in.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.Type"> <summary> <para type="description">Summary object type</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full NAT Rule object</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedNAT.ToFullObj``1(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full NAT Rule object</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule"> <summary> <para type="description">Summary of Where Used Threat Rule results</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.#ctor(psCheckPoint.Objects.CheckPointObject,System.String[],System.String,psCheckPoint.Objects.CheckPointObject,System.String,psCheckPoint.Objects.CheckPointObject)"> <summary> JSON Constructor for Where Used Threat Rule Results </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.Rule"> <summary> <para type="description">Summary of Threat Rule found</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.RuleColumns"> <summary> <para type="description">Columns where object is used in rule.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.Position"> <summary> <para type="description">Rule position</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.Layer"> <summary> <para type="description">Summary of Layer rule exists in.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.LayerPosition"> <summary> <para type="description">Layer position</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.Package"> <summary> <para type="description">Summary of Package NAT rule exists in.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.Type"> <summary> <para type="description">Summary object type</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full Threat Rule object</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.CheckPointWhereUsedThreatRule.ToFullObj``1(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full Threat Rule object</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointCommands"> <api cmd="show-commands">Get-CheckPointCommands</api> <summary> <para type="synopsis"></para> <para type="description"></para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointObjects"> <api cmd="show-objects">Get-CheckPointObjects</api> <summary> <para type="synopsis">Find objects by Filter.</para> <para type="description">Can find many different types of objects based on a filter. Filters are same as what can be used in Smart Console</para> </summary> <example> <code>Get-CheckPointObjects -Filter "O365 OR Office365"</code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Filter"> <summary> <para type="description">Search expression to filter objects by. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. By default, the search involves both a textual search and a IP search. To use IP search only, set the "ip-only" parameter to true.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.IPOnly"> <summary> <para type="description">If using "filter", use this field to search objects by their IP address only, without involving the textual search.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Type"> <summary> <para type="description">The objects' type</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointTask"> <api cmd="show-task">Get-CheckPointTask</api> <summary> <para type="synopsis"></para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointTask.TaskID"> <summary> <para type="description">Unique identifier of task</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointTask.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed"> <api cmd="where-used">Get-CheckPointWhereUsed</api> <summary> <para type="synopsis">Searches for usage of the target object in other objects and rules.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointWhereUsed -Name http</code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.ByUID"> <summary> <para type="description">Force by UID. Used if pipelining in list of UIDs.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.ByName"> <summary> <para type="description">Force by name. Used if pipelining in list of names.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Object"> <summary> <para type="description">Check Point Object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Indirect"> <summary> <para type="description">Search for indirect usage.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.IndirectMaxDepth"> <summary> <para type="description">Maximum nesting level during indirect usage search.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Run(psCheckPoint.Session.CheckPointSession,psCheckPoint.Objects.CheckPointObject,System.Boolean)"> <summary> For running PowerShell Cmdlet from another C# class </summary> <param name="Session">Open Check Point session that will be used for running command</param> <param name="obj">Object to be run against.</param> <param name="indirect">Weather to include indirect uses.</param> <returns>Object contains results.</returns> </member> <member name="T:psCheckPoint.Objects.Misc.InvokeCheckPointScript"> <api cmd="run-script">Invoke-CheckPointScript</api> <summary> <para type="synopsis"></para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.ScriptName"> <summary> <para type="description">Script Name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.Script"> <summary> <para type="description">Script Body</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.ScriptFile"> <summary> <para type="description">Load Script Body from File</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.Args"> <summary> <para type="description">Script arguments.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.Targets"> <summary> <para type="description">On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.InvokeCheckPointScript.Comments"> <summary> <para type="description">Comments string</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer"> <summary> <para type="description">Details of a Check Point Access Layer</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean)"> <summary> JSON Constructor for Access Layer </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.ApplicationsAndUrlFiltering"> <summary> <para type="description">Whether Applications and URL Filtering blade is enabled on this layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.ContentAwareness"> <summary> <para type="description">Whether Content Awareness blade is enabled on this layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.DetectUsingXForwardFor"> <summary> <para type="description">Whether X-Forward-For HTTP header is been used.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.Firewall"> <summary> <para type="description">Whether Firewall blade is enabled on this layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.MobileAccess"> <summary> <para type="description">Whether Mobile Access blade is enabled on this layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.ParentLayer"> <summary> <para type="description">Parent layer of this layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer.Shared"> <summary> <para type="description">Whether this layer is shared.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayers"> <summary> <para type="description">Result from commands that return multiple objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.CheckPointAccessLayers.AccessLayers"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayer"> <api cmd="show-access-layer">Get-CheckPointAccessLayer</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointAccessLayer -Name Network</code> </example> </member> <member name="P:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayer.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayers"> <api cmd="show-access-layers">Get-CheckPointAccessLayers</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointAccessLayers</code> </example> </member> <member name="P:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayers.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer"> <api cmd="add-access-layer">New-CheckPointAccessLayer</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.AddDefaultRule"> <summary> <para type="description">Indicates whether to include a clean-up rule in the new layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.ApplicationsAndUrlFiltering"> <summary> <para type="description">Whether to enable Applications and URL Filtering blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.ContentAwareness"> <summary> <para type="description">Whether to enable Content Awareness blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.DetectUsingXForwardFor"> <summary> <para type="description">Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.Firewall"> <summary> <para type="description">Whether to enable Firewall blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.MobileAccess"> <summary> <para type="description">Whether to enable Mobile Access blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.Shared"> <summary> <para type="description">Whether this layer is shared.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.RemoveCheckPointAccessLayer"> <api cmd="delete-access-layer">Remove-CheckPointAccessLayer</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointAccessLayer -Name Network</code> </example> </member> <member name="P:psCheckPoint.Objects.AccessLayer.RemoveCheckPointAccessLayer.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer"> <api cmd="set-access-layer">Set-CheckPointAccessLayer</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Set-CheckPointAccessLayer -Name Network -ApplicationsAndUrlFiltering $true</code> </example> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.ApplicationsAndUrlFiltering"> <summary> <para type="description">Whether to enable Applications and URL Filtering blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.ContentAwareness"> <summary> <para type="description">Whether to enable Content Awareness blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.DetectUsingXForwardFor"> <summary> <para type="description">Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.Firewall"> <summary> <para type="description">Whether to enable Firewall blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.MobileAccess"> <summary> <para type="description">Whether to enable Mobile Access blade on the layer.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.Shared"> <summary> <para type="description">Whether this layer is shared.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleBase"> <summary> <para type="description">Details of a Check Point Access Rule</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleBase.#ctor(System.String,System.String,System.Collections.Generic.List{psCheckPoint.Objects.AccessRule.CheckPointAccessRule})"> <summary> JSON Constructor for Access Rule </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleBase.Name"> <summary> <para type="description">Object name. Should be unique in the domain.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleBase.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleBase.RuleBase"> <summary> <para type="description">Rule base.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary"> <summary> <para type="description">Details of a Check Point Access Rule</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.Boolean,System.String,System.Int32)"> <summary> JSON Constructor for Access Rule </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary.Enabled"> <summary> <para type="description">Enable/Disable the rule.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary.Layer"> <summary> <para type="description">N/A</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary.RuleNumber"> <summary> <para type="description">Rule number in rulebase</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.CheckPointAccessRuleSummary.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full object from summary</para> </summary> <param name="Session">Current session used to get full details</param> <returns>Full details of object. If psCheckPoint doesn't implement the commands to get the full details of this object yet, returns this. If object not found then returns null.</returns> </member> <member name="T:psCheckPoint.Objects.AccessRule.CheckPointAccessRule"> <summary> <para type="description">Details of a Check Point Access Rule</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.Boolean,System.String,System.Int32,psCheckPoint.Objects.CheckPointObject,psCheckPoint.Objects.CheckPointObject[],System.Boolean,psCheckPoint.Objects.CheckPointObject,psCheckPoint.Objects.CheckPointObject[],psCheckPoint.Objects.CheckPointMetaInfo,psCheckPoint.Objects.CheckPointObject[],System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.Boolean,psCheckPoint.Objects.CheckPointObject[],psCheckPoint.Objects.CheckPointObject[],System.String)"> <summary> JSON Constructor for Access Rule </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Action"> <summary> <para type="description">"Accept", "Drop", "Ask", "Inform", "Reject", "User Auth", "Client Auth", "Apply Layer". How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Destination"> <summary> <para type="description">Collection of Network objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.DestinationNegate"> <summary> <para type="description">True if negate is set for destination.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.InlineLayer"> <summary> <para type="description">Inline Layer identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.InstallOn"> <summary> <para type="description">Which gateway, identified by the name or UID, to install the policy. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.MetaInfo"> <summary> <para type="description">Object metadata.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Service"> <summary> <para type="description">Collection of Network objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.ServiceNegate"> <summary> <para type="description">True if negate is set for service.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Source"> <summary> <para type="description">Collection of Network objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.SourceNegate"> <summary> <para type="description">True if negate is set for source.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Time"> <summary> <para type="description">List of time objects. For example: "Weekend", "Off-Work", "Every-Day". How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.VPN"> <summary> <para type="description">VPN settings. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.CheckPointAccessRule.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase"> <api cmd="show-access-rulebase">Get-CheckPointAccessRuleBase</api> <summary> <para type="synopsis">Shows the entire Access Rules layer.</para> <para type="description">Shows the entire Access Rules layer. This layer is divided into sections. An Access Rule may be within a section, or independent of a section (in which case it is said to be under the "global" section). The reply features a list of objects. Each object may be a section of the layer, with all its rules in, or a rule itself, for the case of rules which are under the global section. An optional "filter" field may be added in order to filter out only those rules that match a search criteria.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.Filter"> <summary> <para type="description">Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.UseObjectDictionary"> <summary> <para type="description"></para> </summary> </member> <member name="T:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule"> <api cmd="show-access-rule">Get-CheckPointAccessRule</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.RuleNumber"> <summary> <para type="description">Rule number.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.Layer"> <summary> <para type="description">Layer that the rule belongs to identified by the name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="T:psCheckPoint.Objects.CheckPointObjectsBase`1"> <summary> <para type="description">Result from commands that return multiple objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectsBase`1.From"> <summary> <para type="description">From which element number the query was done.</para> </summary> </member> <member name="F:psCheckPoint.Objects.CheckPointObjectsBase`1._Objects"> <summary> List of objects that other classes should implement a public property to expose. </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectsBase`1.To"> <summary> <para type="description">To which element number the query was done.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectsBase`1.Total"> <summary> <para type="description">Total number of elements returned by the query.</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObjectsBase`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection of Objects. </summary> <returns>An IEnumerator object that can be used to iterate through the collection.</returns> </member> <member name="M:psCheckPoint.Objects.CheckPointObjectsBase`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through the collection of Objects. </summary> <returns>An IEnumerator object that can be used to iterate through the collection.</returns> </member> <member name="T:psCheckPoint.Objects.GetCheckPointFullObject"> <extra category="Misc.">Get-CheckPointFullObject</extra> <summary> <para type="synopsis">Retrieve full object details from object summary.</para> <para type="description">Many commands return lists of object summaries.</para> <para type="description">Use this to return the full objects for each summary.</para> </summary> <example> <code>Get-CheckPointGroups | Get-CheckPointFullObject</code> </example> </member> <member name="P:psCheckPoint.Objects.GetCheckPointFullObject.Session"> <summary> <para type="description">Session object from Open-CheckPointSession</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointFullObject.Object"> <summary> <para type="description">Input objects to start export from.</para> </summary> </member> <member name="M:psCheckPoint.Objects.GetCheckPointFullObject.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.Objects.ICheckPointObjectSummary"> <summary> <para type="description">Any object that can be expanded into the full object details from.</para> <para type="description">If object is already full details then just returns itself.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ICheckPointObjectSummary.Type"> <summary> <para type="description">Check Point Web-API Type field</para> </summary> </member> <member name="M:psCheckPoint.Objects.ICheckPointObjectSummary.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full object from summary</para> </summary> <param name="Session">Current session used to get full details</param> <returns>Full details of object. If psCheckPoint doesn't implement the commands to get the full details of this object yet, returns this. If object not found then returns null.</returns> </member> <member name="M:psCheckPoint.Objects.ICheckPointObjectSummary.ToFullObj``1(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full object from summary</para> </summary> <typeparam name="T">Type object should be returned as.</typeparam> <param name="Session">Current session used to get full details.</param> <returns>Full details of object.</returns> <exception cref="T:System.InvalidCastException">If full object is not of type T.</exception> </member> <member name="T:psCheckPoint.Objects.Policy.TestCheckPointPolicy"> <api cmd="verify-policy">Test-CheckPointPolicy</api> <summary> <para type="synopsis"></para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.TestCheckPointPolicy.PolicyPackage"> <summary> <para type="description">The name of the Policy Package to be installed.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Policy.InstallCheckPointPolicy"> <api cmd="install-policy">Install-CheckPointPolicy</api> <summary> <para type="synopsis"></para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.PolicyPackage"> <summary> <para type="description">The name of the Policy Package to be installed.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.Access"> <summary> <para type="description">Set to be true in order to install the access policy.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.DisableInstallOnAllClusterMembersOrFail"> <summary> <para type="description">install-on-all-cluster-members-or-fail</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.PrepareOnly"> <summary> <para type="description">If true, prepares the policy for the installation, but doesn't install it on an installation target.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.Revision"> <summary> <para type="description">The UID of the revision of the policy to install.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.Targets"> <summary> <para type="description">On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.ThreatPrevention"> <summary> <para type="description">Set to be true in order to install the threat prevention policy.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup"> <summary> <para type="description">Details of a Check Point Service Group</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],psCheckPoint.Objects.CheckPointObject[])"> <summary> JSON Constructor for Service Group </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup.Members"> <summary> <para type="description">Collection of Network objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup.ShouldSerializeMembers"> <summary> Conditional Property Serialization for Members </summary> <returns>true if Members should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroup"> <api cmd="show-service-group">Get-CheckPointServiceGroup</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointGroup -Name Test1</code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroups"> <api cmd="show-service-groups">Get-CheckPointServiceGroups</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroups.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup"> <api cmd="add-service-group">New-CheckPointServiceGroup</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.Members"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup"> <api cmd="delete-service-group">Remove-CheckPointServiceGroup</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointGroup -Name Test1 -Verbose</code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup"> <api cmd="set-service-group">Set-CheckPointServiceGroup</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Set-CheckPointGroup -Name Test1 -NewName Test2 -Tags TestTag</code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.MemberAction"> <summary> <para type="description">Action to take with members.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.Members"> <summary> <para type="description">Collection of Network objects identified by the name or UID.</para> <para type="description">Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion"> <summary> <para type="description">Details of a Check Point Group with Exclusion</para> </summary> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject,psCheckPoint.Objects.CheckPointObject)"> <summary> JSON Constructor for Group with Exclusion </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion.Include"> <summary> <para type="description">Object which the group includes</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion.Except"> <summary> <para type="description">Object which the group excludes</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupWithExclusion"> <api cmd="show-group-with-exclusion">Get-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupWithExclusion.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupsWithExclusion"> <api cmd="show-groups-with-exclusion">Get-CheckPointGroupsWithExclusion</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupsWithExclusion.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion"> <api cmd="add-group-with-exclusion">New-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.Include"> <summary> <para type="description">Object to include.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.Except"> <summary> <para type="description">Object to exclude.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion"> <api cmd="delete-group-with-exclusion">Remove-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointHostWithExclusion"> <api cmd="set-group-with-exclusion">Set-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointHostWithExclusion.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointHostWithExclusion.Include"> <summary> <para type="description">Object to include.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointHostWithExclusion.Except"> <summary> <para type="description">Object to exclude.</para> </summary> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange"> <summary> <para type="description">Details of a Check Point Multicast Address Range</para> </summary> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,System.String,System.String)"> <summary> JSON Constructor for Multicast Address Range </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRange"> <api cmd="show-multicast-address-range">Get-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRanges"> <api cmd="show-multicast-address-ranges">Get-CheckPointMulticastAddressRanges</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRanges.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange"> <api cmd="add-multicast-address-range">New-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPAddressFirst"> <summary> <para type="description">First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPAddressLast"> <summary> <para type="description">Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange"> <api cmd="delete-multicast-address-range">Remove-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange"> <api cmd="set-multicast-address-range">Set-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPAddressFirst"> <summary> <para type="description">First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPAddressLast"> <summary> <para type="description">Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AddressRange.CheckPointAddressRange"> <summary> <para type="description">Details of a Check Point Address Range</para> </summary> </member> <member name="M:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,System.String,System.String)"> <summary> JSON Constructor for Address Range </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="M:psCheckPoint.Objects.AddressRange.CheckPointAddressRange.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRange"> <api cmd="show-address-range">Get-CheckPointAddressRange</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRanges"> <api cmd="show-address-ranges">Get-CheckPointAddressRanges</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRanges.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange"> <api cmd="add-address-range">New-CheckPointAddressRange</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPAddressFirst"> <summary> <para type="description">First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPAddressLast"> <summary> <para type="description">Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange"> <api cmd="delete-address-range">Remove-CheckPointAddressRange</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange"> <api cmd="set-address-range">Set-CheckPointAddressRange</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPAddressFirst"> <summary> <para type="description">First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPAddressLast"> <summary> <para type="description">Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPv4AddressFirst"> <summary> <para type="description">First IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPv4AddressLast"> <summary> <para type="description">Last IPv4 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPv6AddressFirst"> <summary> <para type="description">First IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.IPv6AddressLast"> <summary> <para type="description">Last IPv6 address in the range.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.CheckPointDomain"> <summary> <para type="description">Details of a Check Point Domain</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointDomain.#ctor(System.String,System.String,System.String)"> <summary> JSON Constructor for Domain information </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointDomain.Name"> <summary> <para type="description">Object name. Should be unique in the domain.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointDomain.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointDomain.DomainType"> <summary> <para type="description">Domain type.</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointDomain.ToString"> <summary> <para type="description">Convert domain object to string. (Domain name)</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointDomain.Equals(System.Object)"> <summary> <para type="description">Returns true if object UIDs match</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointDomain.GetHashCode"> <summary> <para type="description">Returns Hashcode of object UID</para> </summary> </member> <member name="T:psCheckPoint.Objects.CheckPointMetaInfo"> <summary> <para type="description">Meta Information attached to Check Point Objects</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointMetaInfo.#ctor(psCheckPoint.Objects.CheckPointTime,System.String,System.String,psCheckPoint.Objects.CheckPointTime,System.String,System.String)"> <summary> JSON Constructor for Check Point Meta-Info </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.CreationTime"> <summary> <para type="description">Time object created</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.Creator"> <summary> <para type="description">Created by</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.LastModifier"> <summary> <para type="description">Last modified by</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.LastModifyTime"> <summary> <para type="description">Time last modified</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.Lock"> <summary> <para type="description">Object lock state. It's not allowed to edit objects locked by other session.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointMetaInfo.ValidationState"> <summary> <para type="description">Any validation errors attached to the object</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointMetaInfo.ToString"> <summary> <para type="description">Convert Meta Info to a string</para> </summary> </member> <member name="T:psCheckPoint.Objects.CheckPointObjectFull"> <summary> <para type="description">Extended summary details of most Check Point Objects</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObjectFull.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String)"> <summary> JSON Constructor for Common Check Point Object Details </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.Icon"> <summary> <para type="description">Object icon.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.MetaInfo"> <summary> <para type="description">Object metadata.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.ReadOnly"> <summary> <para type="description">Indicates whether the object is read-only.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.Tags"> <summary> <para type="description">Collection of tag objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.Color"> <summary> <para type="description">Color of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjectFull.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObjectFull.ShouldSerializeTags"> <summary> Conditional Property Serialization for Tags </summary> <returns>true if Tags should be serialised.</returns> </member> <member name="M:psCheckPoint.Objects.CheckPointObjectFull.ShouldSerializeColor"> <summary> Conditional Property Serialization for Color </summary> <returns>true if Color should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.CheckPointObject"> <summary> <para type="description">Base summary details of Check Point Objects</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain)"> <summary> JSON Constructor for Check Point Object Summary </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObject.Name"> <summary> <para type="description">Object name. Should be unique in the domain.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObject.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObject.Type"> <summary> <para type="description">Type of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObject.Domain"> <summary> <para type="description">Information about the domain the object belongs to..</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.ShouldSerializeDomain"> <summary> Conditional Property Serialization for Domain </summary> <returns>true if Domain should be serialised.</returns> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.ToString"> <summary> <para type="description">Convert object to string. (Object name or UID if not Name)</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.Equals(System.Object)"> <summary> <para type="description">Returns true if object UIDs match</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.GetHashCode"> <summary> <para type="description">Returns Hashcode of object UID</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.ToFullObj(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full object from summary</para> </summary> <param name="Session">Current session used to get full details</param> <returns>Full details of object. If psCheckPoint doesn't implement the commands to get the full details of this object yet, returns this. If object not found then returns null.</returns> </member> <member name="M:psCheckPoint.Objects.CheckPointObject.ToFullObj``1(psCheckPoint.Session.CheckPointSession)"> <summary> <para type="description">Return full object from summary</para> </summary> <typeparam name="T">Type object should be returned as.</typeparam> <param name="Session">Current session used to get full details.</param> <returns>Full details of object.</returns> <exception cref="T:System.InvalidCastException">If full object is not of type T.</exception> </member> <member name="T:psCheckPoint.Objects.CheckPointObjects"> <summary> <para type="description">Result from commands that return multiple objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointObjects.Objects"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="T:psCheckPoint.Objects.CheckPointTime"> <summary> <para type="description">Check Point Object's Time Fields</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointTime.#ctor(System.String,System.Int64)"> <summary> JSON Constructor for Check Point Time Object </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointTime.ISO8601"> <summary> <para type="description">Date and time represented in international ISO 8601 format.</para> </summary> </member> <member name="P:psCheckPoint.Objects.CheckPointTime.Posix"> <summary> <para type="description">Number of milliseconds that have elapsed since 00:00:00, 1 January 1970.</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointTime.AsDateTime"> <summary> <para type="description">Return as a standard c# DateTime object</para> </summary> </member> <member name="M:psCheckPoint.Objects.CheckPointTime.ToString"> <summary> Returns as string </summary> <returns>String of date and time</returns> </member> <member name="T:psCheckPoint.Objects.Group.CheckPointGroup"> <summary> <para type="description">Details of a Check Point Group</para> </summary> </member> <member name="M:psCheckPoint.Objects.Group.CheckPointGroup.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],psCheckPoint.Objects.CheckPointObject[])"> <summary> JSON Constructor for Group </summary> </member> <member name="P:psCheckPoint.Objects.Group.CheckPointGroup.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.CheckPointGroup.Members"> <summary> <para type="description">Collection of Network objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Group.CheckPointGroup.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="M:psCheckPoint.Objects.Group.CheckPointGroup.ShouldSerializeMembers"> <summary> Conditional Property Serialization for Members </summary> <returns>true if Members should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.Group.GetCheckPointGroup"> <api cmd="show-group">Get-CheckPointGroup</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>$cpGroup = Get-CheckPointGroup -Name Test1</code> </example> </member> <member name="P:psCheckPoint.Objects.Group.GetCheckPointGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Group.GetCheckPointGroups"> <api cmd="show-groups">Get-CheckPointGroups</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointGroups</code> </example> </member> <member name="P:psCheckPoint.Objects.Group.GetCheckPointGroups.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Group.NewCheckPointGroup"> <api cmd="add-group">New-CheckPointGroup</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.Group.NewCheckPointGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.NewCheckPointGroup.Members"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.NewCheckPointGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Group.RemoveCheckPointGroup"> <api cmd="delete-group">Remove-CheckPointGroup</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointGroup -Name Test1 -Verbose</code> </example> </member> <member name="P:psCheckPoint.Objects.Group.RemoveCheckPointGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Group.SetCheckPointGroup"> <api cmd="set-group">Set-CheckPointGroup</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>$cpGroup = Set-CheckPointGroup -Name Test1 -NewName Test2 -Tags TestTag</code> </example> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.MemberAction"> <summary> <para type="description">Action to take with members.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.Members"> <summary> <para type="description">Collection of Network objects identified by the name or UID.</para> <para type="description">Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Network.CheckPointNetwork"> <summary> <para type="description">Details of a Check Point Network</para> </summary> </member> <member name="M:psCheckPoint.Objects.Network.CheckPointNetwork.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,System.String,System.Int32,System.Int32,System.String)"> <summary> JSON Constructor for Network </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.Subnet4"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.Subnet6"> <summary> <para type="description">IPv6 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.Broadcast"> <summary> <para type="description">Allow broadcast address inclusion.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.MaskLength4"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.MaskLength6"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.CheckPointNetwork.SubnetMask"> <summary> <para type="description">IPv4 network mask.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Network.CheckPointNetwork.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.Network.GetCheckPointNetwork"> <api cmd="show-network">Get-CheckPointNetwork</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointNetwork -Name Test1</code> </example> </member> <member name="P:psCheckPoint.Objects.Network.GetCheckPointNetwork.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Network.GetCheckPointNetworks"> <api cmd="show-networks">Get-CheckPointNetworks</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointNetworks</code> </example> </member> <member name="P:psCheckPoint.Objects.Network.GetCheckPointNetworks.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Network.NewCheckPointNetwork"> <api cmd="add-network">New-CheckPointNetwork</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code>New-CheckPointNetwork -Name Test1 ...</code> </example> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Subnet"> <summary> <para type="description">IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Subnet4"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Subnet6"> <summary> <para type="description">IPv6 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.MaskLength"> <summary> <para type="description">IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.MaskLength4"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.MaskLength6"> <summary> <para type="description">IPv6 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.SubnetMask"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Broadcast"> <summary> <para type="description">Allow broadcast address inclusion.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.NewCheckPointNetwork.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Network.RemoveCheckPointNetwork"> <api cmd="delete-network">Remove-CheckPointNetwork</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointNetwork -Name Test1 -Verbose</code> </example> </member> <member name="P:psCheckPoint.Objects.Network.RemoveCheckPointNetwork.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Network.SetCheckPointNetwork"> <api cmd="set-network">Set-CheckPointNetwork</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Set-CheckPointNetwork -Name Test1 -NewName Test2 -Tags TestTag</code> </example> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Subnet"> <summary> <para type="description">IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Subnet4"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Subnet6"> <summary> <para type="description">IPv6 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.MaskLength"> <summary> <para type="description">IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.MaskLength4"> <summary> <para type="description">IPv4 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.MaskLength6"> <summary> <para type="description">IPv6 network mask length.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.SubnetMask"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Broadcast"> <summary> <para type="description">Allow broadcast address inclusion.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP"> <summary> <para type="description">Details of a Check Point UDP Service</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean)"> <summary> JSON Constructor for UDP Service </summary> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP.ToString"> <summary> Converts UDP port to a string </summary> <returns>String of UDP port</returns> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP.AcceptReplies"> <summary> <para type="description"></para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.GetCheckPointServicesUDP"> <api cmd="show-services-udp">Get-CheckPointServicesUDP</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.GetCheckPointServicesUDP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.GetCheckPointServiceUDP"> <api cmd="show-service-udp">Get-CheckPointServiceUDP</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.GetCheckPointServiceUDP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP"> <api cmd="add-service-udp">New-CheckPointServiceUDP</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.AcceptReplies"> <summary> <para type="description">N/A</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP"> <api cmd="delete-service-udp">Remove-CheckPointServiceUDP</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP"> <api cmd="set-service-udp">Set-CheckPointServiceUDP</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.AcceptReplies"> <summary> <para type="description">N/A</para> </summary> </member> <member name="T:psCheckPoint.Objects.Service.CheckPointServices"> <summary> <para type="description">Result from commands that return multiple objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServices.Objects"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Service.CheckPointService"> <summary> </summary> </member> <member name="M:psCheckPoint.Objects.Service.CheckPointService.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String)"> <summary> JSON Constructor for Check Point Service Summary </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointService.Port"> <summary> <para type="description">The number of the port used to provide this service.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Service.CheckPointServiceBase"> <summary> <para type="description">Base details of a Check Point Service</para> </summary> </member> <member name="M:psCheckPoint.Objects.Service.CheckPointServiceBase.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean)"> <summary> JSON Constructor for Common Service Properties </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.KeepConnectionsOpenAfterPolicyInstallation"> <summary> <para type="description">Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.MatchByProtocolSignature"> <summary> <para type="description">A value of true enables matching by the selected protocol's signature - The signature identifies the protocol as genuine.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.MatchForAny"> <summary> <para type="description">Indicates whether this service is used when 'Any' is set as the rule's service and there are several service objects with the same source port and protocol.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.OverrideDefaultSettings"> <summary> <para type="description">Indicates whether this service is a Data Domain service which has been overridden.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Protocol"> <summary> <para type="description">The protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.SourcePort"> <summary> <para type="description">Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.SyncConnectionsOnCluster"> <summary> <para type="description">Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Service.CheckPointServiceBase.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Icon"> <summary> <para type="description">Object icon.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.MetaInfo"> <summary> <para type="description">Object metadata.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.ReadOnly"> <summary> <para type="description">Indicates whether the object is read-only.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Tags"> <summary> <para type="description">Collection of tag objects identified by the name or UID. How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Color"> <summary> <para type="description">Color of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.CheckPointServiceBase.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Service.CheckPointServiceBase.ShouldSerializeTags"> <summary> Conditional Property Serialization for Tags </summary> <returns>true if Tags should be serialised.</returns> </member> <member name="M:psCheckPoint.Objects.Service.CheckPointServiceBase.ShouldSerializeColor"> <summary> Conditional Property Serialization for Color </summary> <returns>true if Color should be serialised.</returns> </member> <member name="T:psCheckPoint.Objects.Service.NewCheckPointService`1"> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.KeepConnectionsOpenAfterPolicyInstallation"> <summary> <para type="description">Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.MatchByProtocolSignature"> <summary> <para type="description">A value of true enables matching by the selected protocol's signature - the signature identifies the protocol as genuine. Select this option to limit the port to the specified protocol. If the selected protocol does not support matching by signature, this field cannot be set to true.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.MatchForAny"> <summary> <para type="description">Indicates whether this service is used when 'Any' is set as the rule's service and there are several service objects with the same source port and protocol.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.OverrideDefaultSettings"> <summary> <para type="description">Indicates whether this service is a Data Domain service which has been overridden.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.Port"> <summary> <para type="description">The number of the port used to provide this service. To specify a port range, place a hyphen between the lowest and highest port numbers, for example 44-55.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.Protocol"> <summary> <para type="description">Select the protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service. Selecting a Protocol Type invokes the specific protocol handlers for each protocol type, thus enabling higher level of security by parsing the protocol, and higher level of connectivity by tracking dynamic actions (such as opening of ports).</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.SourcePort"> <summary> <para type="description">Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.SyncConnectionsOnCluster"> <summary> <para type="description">Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.NewCheckPointService`1.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Service.SetCheckPointService`1"> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.KeepConnectionsOpenAfterPolicyInstallation"> <summary> <para type="description">Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.MatchByProtocolSignature"> <summary> <para type="description">A value of true enables matching by the selected protocol's signature - the signature identifies the protocol as genuine. Select this option to limit the port to the specified protocol. If the selected protocol does not support matching by signature, this field cannot be set to true.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.MatchForAny"> <summary> <para type="description">Indicates whether this service is used when 'Any' is set as the rule's service and there are several service objects with the same source port and protocol.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.OverrideDefaultSettings"> <summary> <para type="description">Indicates whether this service is a Data Domain service which has been overridden.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.Port"> <summary> <para type="description">The number of the port used to provide this service. To specify a port range, place a hyphen between the lowest and highest port numbers, for example 44-55.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.Protocol"> <summary> <para type="description">Select the protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service. Selecting a Protocol Type invokes the specific protocol handlers for each protocol type, thus enabling higher level of security by parsing the protocol, and higher level of connectivity by tracking dynamic actions (such as opening of ports).</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.SourcePort"> <summary> <para type="description">Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.SyncConnectionsOnCluster"> <summary> <para type="description">Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Service.SetCheckPointService`1.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Session.CheckPointSessions"> <summary> <para type="description">Result from commands that return multiple objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSessions.Sessions"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Session.CheckPointSession"> <summary> <para type="description">Details of a Check Point Session</para> <para type="description">This session object does NOT include login details so cannot be used as Session parameter in other commands</para> </summary> </member> <member name="M:psCheckPoint.Objects.Session.CheckPointSession.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Boolean,System.Boolean,System.String,psCheckPoint.Objects.CheckPointTime,psCheckPoint.Objects.CheckPointTime,System.Int32,System.String,psCheckPoint.Objects.CheckPointTime,System.Int32,System.String,System.String)"> <summary> JSON Constructor for Session </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.Application"> <summary> <para type="description">The name of the application serving the web_api requests.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.Changes"> <summary> <para type="description">Number of pending changes.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.ConnectionMode"> <summary> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.Description"> <summary> <para type="description">Session description.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.Email"> <summary> <para type="description">Administrator email.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.ExpiredSession"> <summary> <para type="description">True if the session is expired.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.InWork"> <summary> <para type="description">True if the session is in work state.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.IPAddress"> <summary> <para type="description">IP address from which the session was initiated.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.LastLoginTime"> <summary> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.LastLogoutTime"> <summary> <para type="description">Timestamp when user last accessed the management server.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.Locks"> <summary> <para type="description">Number of locked objects.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.PhoneNumber"> <summary> <para type="description">Administrator phone number.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.PublishTime"> <summary> <para type="description">Timestamp when user published changes on the management server.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.SessionTimeout"> <summary> <para type="description">Session expiration timeout in seconds.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.State"> <summary> <para type="description">Session state.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.CheckPointSession.UserName"> <summary> <para type="description">The name of the logged in user.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Session.GetCheckPointSession"> <api cmd="show-session">Get-CheckPointSession</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointSession</code> </example> </member> <member name="P:psCheckPoint.Objects.Session.GetCheckPointSession.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.GetCheckPointSession.UID"> <summary> <para type="description">Session unique identifier. If not provided the current logged in session UID will be used.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Session.GetCheckPointSessions"> <api cmd="show-sessions">Get-CheckPointSessions</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="M:psCheckPoint.Objects.Session.GetCheckPointSessions.#ctor"> <summary> Default constructor the changes GetCheckPointObjects.DetailsLevel default setting </summary> </member> <member name="P:psCheckPoint.Objects.Session.GetCheckPointSessions.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Session.GetCheckPointSessions.ViewPublishedSessions"> <summary> <para type="description">Show a list of published sessions.</para> </summary> </member> <member name="T:psCheckPoint.Objects.SetCheckPointObject`1"> <summary> <para type="description">Base class for Set-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.NewName"> <summary> <para type="description">New name of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.Tags"> <summary> <para type="description">Collection of tag identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.IgnoreWarnings"> <summary> <para type="description">Apply changes ignoring warnings.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.IgnoreErrors"> <summary> <para type="description">Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SetCheckPointObject`1.PassThru"> <summary> <para type="description">Return the updated object.</para> </summary> </member> <member name="T:psCheckPoint.Objects.RemoveCheckPointObject"> <summary> <para type="description">Base class for Remove-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.IgnoreWarnings"> <summary> <para type="description">Apply changes ignoring warnings.</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.IgnoreErrors"> <summary> <para type="description">Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GetCheckPointObjects"> <summary> <para type="description">Base class for Get-CheckPoint*ObjectName*s classes</para> </summary> </member> <member name="T:psCheckPoint.Objects.GetCheckPointObjectsBase`1"> <summary> <para type="description">Base class for Get-CheckPoint*ObjectName*s classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjectsBase`1.UID"> <summary> <para type="description">No more than that many results will be returned.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjectsBase`1.Name"> <summary> <para type="description">Skip that many results before beginning to return them.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjectsBase`1.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="T:psCheckPoint.Objects.GetCheckPointObject`1"> <summary> <para type="description">Base class for Get-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObject`1.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObject`1.Name"> <summary> <para type="description">Object name.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObject`1.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="T:psCheckPoint.Objects.NewCheckPointObject`1"> <summary> <para type="description">Base class for New-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.NewCheckPointObject`1.SetIfExists"> <summary> <para type="description">If another object with the same identifier already exists, it will be updated. The command behaviour will be the same as if originally a set command was called. Pay attention that original object's fields will be overwritten by the fields provided in the request payload!</para> </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.CheckPointSecurityZone"> <summary> <para type="description">Details of a Check Point Security Zone</para> </summary> </member> <member name="M:psCheckPoint.Objects.SecurityZone.CheckPointSecurityZone.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String)"> <summary> JSON Constructor for Security Zone </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZone"> <api cmd="show-security-zone">Get-CheckPointSecurityZone</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZone.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZones"> <api cmd="show-security-zones">Get-CheckPointSecurityZones</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZones.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.NewCheckPointSecurityZone"> <api cmd="add-security-zone">New-CheckPointSecurityZone</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.NewCheckPointSecurityZone.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone"> <api cmd="delete-security-zone">Remove-CheckPointSecurityZone</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone"> <api cmd="set-security-zone">Set-CheckPointSecurityZone</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP"> <summary> <para type="description">Details of a Check Point TCP Service</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean)"> <summary> JSON Constructor for TCP Service </summary> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP.ToString"> <summary> Converts TCP port to a string </summary> <returns>String of TCP port</returns> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.GetCheckPointServiceTCP"> <api cmd="show-service-tcp">Get-CheckPointServiceTCP</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.GetCheckPointServiceTCP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.GetCheckPointServicesTCP"> <api cmd="show-services-tcp">Get-CheckPointServicesTCP</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.GetCheckPointServicesTCP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP"> <api cmd="add-service-tcp">New-CheckPointServiceTCP</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP"> <api cmd="delete-service-tcp">Remove-CheckPointServiceTCP</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP"> <api cmd="set-service-tcp">Set-CheckPointServiceTCP</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Application.CheckPointApplication"> <summary> <para type="description">Details of a Check Point Application/Site</para> </summary> </member> <member name="M:psCheckPoint.Objects.Application.CheckPointApplication.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointDomain,System.String,psCheckPoint.Objects.CheckPointMetaInfo,System.Boolean,psCheckPoint.Objects.CheckPointObject[],System.String,System.String,psCheckPoint.Objects.CheckPointObject[],System.String[],System.Int32,System.String,System.String,System.String,System.String,System.String[],System.Boolean,System.Boolean)"> <summary> JSON Constructor for Network </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.Groups"> <summary> <para type="description">How much details are returned depends on the details-level field of the request. This table shows the level of detail shown when details-level is set to standard.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.AdditionalCategories"> <summary> <para type="description">Additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.ApplicationID"> <summary> <para type="description">Application ID</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.ApplicationSignature"> <summary> <para type="description">Application signature generated by Signature Tool.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.Description"> <summary> <para type="description">Application description.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.PrimaryCategory"> <summary> <para type="description">Primary application category.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.Risk"> <summary> <para type="description">Application risk.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.UrlList"> <summary> <para type="description">URLs that determine this particular application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.UrlsDefinedAsRegularExpression"> <summary> <para type="description">URLs defined as regular expression.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.CheckPointApplication.UserDefined"> <summary> <para type="description">True if this application site was defined by user (not predefined one).</para> </summary> </member> <member name="T:psCheckPoint.Objects.Application.GetCheckPointApplication"> <api cmd="show-application-site">Get-CheckPointApplication</api> <summary> <para type="synopsis">Retrieve existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.Application.GetCheckPointApplication.ApplicationID"> <summary> <para type="description">Object application identifier.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Application.GetCheckPointApplications"> <api cmd="show-application-sites">Get-CheckPointApplications</api> <summary> <para type="synopsis">Retrieve all objects.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="T:psCheckPoint.Objects.Application.NewCheckPointApplication"> <api cmd="add-application-site">New-CheckPointApplication</api> <summary> <para type="synopsis">Create new object.</para> <para type="description"></para> </summary> <example> <code></code> </example> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.PrimaryCategory"> <summary> <para type="description">Each application is assigned to one primary category based on its most defining aspect.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.UrlList"> <summary> <para type="description">URLs that determine this particular application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.ApplicationSignature"> <summary> <para type="description">Application signature generated by Signature Tool.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.AdditionalCategories"> <summary> <para type="description">Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.Description"> <summary> <para type="description">A description for the application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.NewCheckPointApplication.UrlsDefinedAsRegularExpression"> <summary> <para type="description">States whether the URL is defined as a Regular Expression or not.</para> </summary> </member> <member name="T:psCheckPoint.Objects.Application.RemoveCheckPointApplication"> <api cmd="delete-application-site">Remove-CheckPointApplication</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="T:psCheckPoint.Objects.Application.SetCheckPointApplication"> <api cmd="set-application-site">Set-CheckPointApplication</api> <summary> <para type="synopsis">Edit existing object using object name or uid.</para> <para type="description"></para> </summary> <example> </example> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.Groups"> <summary> <para type="description">Collection of group identifiers.</para> <para type="description">Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.PrimaryCategory"> <summary> <para type="description">Each application is assigned to one primary category based on its most defining aspect.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.UrlAction"> <summary> <para type="description">Action to take with URLs.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.UrlList"> <summary> <para type="description">URLs that determine this particular application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.ApplicationSignatureAction"> <summary> <para type="description">Action to take with Application Signatures.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.ApplicationSignature"> <summary> <para type="description">Application signature generated by Signature Tool.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.AdditionalCategoriesAction"> <summary> <para type="description">Action to take with Additional Categories.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.AdditionalCategories"> <summary> <para type="description">Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.Description"> <summary> <para type="description">A description for the application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.UrlsDefinedAsRegularExpression"> <summary> <para type="description">States whether the URL is defined as a Regular Expression or not.</para> </summary> </member> <member name="T:psCheckPoint.IA.AddCheckPointIdentity"> <IA cmd="add-identity">Add-CheckPointIdentity</IA> <summary> <para type="synopsis">Creates a new Identity Awareness association for a specified IP address.</para> <para type="description"></para> </summary> <example> <code>Add-CheckPointIdentity -Gateway 192.168.1.1 -SharedSecret *** -NoCertificateValidation -IPAddress 192.168.1.2 -NoFetchUserGroups -NoFetchMachineGroups -NoCalculateRoles -User "Test User" -Machine "Test Machine" -Roles "Test Role"</code> </example> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.IPAddress"> <summary> <para type="description">Association IP. Supports either IPv4 or IPv6, but not both.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.User"> <summary> <para type="description">User name</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.Machine"> <summary> <para type="description">Computer name</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.Domain"> <summary> <para type="description">Domain name</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.SessionTimeout"> <summary> <para type="description">Timeout (in seconds) for this Identity Awareness association.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.NoFetchUserGroups"> <summary> <para type="description">Defines whether Identity Awareness fetches the user's groups from the user directories defined in SmartConsole.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.NoFetchMachineGroups"> <summary> <para type="description">Defines whether Identity Awareness fetches the machine's groups from the user directories defined in SmartConsole.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.UserGroups"> <summary> <para type="description">List of groups to which the user belongs (when Identity Awareness does not fetch user groups).</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.MachineGroups"> <summary> <para type="description">List of groups to which the computer belongs(when Identity Awareness does not fetch computer groups).</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.NoCalculateRoles"> <summary> <para type="description">Defines whether Identity Awareness calculates the identity’s access roles.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.Roles"> <summary> <para type="description">List of roles to assign to this identity (when Identity Awareness does not calculate roles).</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.MachineOS"> <summary> <para type="description">Host operating system. For example: Windows 7.</para> </summary> </member> <member name="P:psCheckPoint.IA.AddCheckPointIdentity.HostType"> <summary> <para type="description">Type of host device. For example: Apple iOS device.</para> </summary> </member> <member name="M:psCheckPoint.IA.AddCheckPointIdentity.BeginProcessing"> <summary> Provides a one-time, preprocessing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.AddCheckPointIdentity.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.AddCheckPointIdentity.EndProcessing"> <summary> Provides a one-time, post-processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.IA.Identity"> <summary> Stores identity to be sent ready for serialization to JSON request. </summary> </member> <member name="T:psCheckPoint.IA.AddIdentityResponse"> <summary> <para type="synopsis">Response from Add-CheckPointIdentity</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.IA.AddIdentityResponse.IPv4Address"> <summary> <para type="description">Created IPv4 identity</para> </summary> </member> <member name="P:psCheckPoint.IA.AddIdentityResponse.IPv6Address"> <summary> <para type="description">Created IPv6 identity</para> </summary> </member> <member name="P:psCheckPoint.IA.AddIdentityResponse.Message"> <summary> <para type="description">Textual description of the command’s result</para> </summary> </member> <member name="T:psCheckPoint.IA.CheckPointIACmdlet"> <summary> <para type="synopsis">Queries the Identity Awareness associations of a given IP.</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.Gateway"> <summary> <para type="description">IP or Hostname of the gateway server.</para> </summary> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.SharedSecret"> <summary> <para type="description">Shared secret.</para> </summary> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.BatchSize"> <summary> <para type="description">When using pipeline to send multiple requests at once, how many to batch together and send as single request.</para> </summary> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.NoCertificateValidation"> <summary> <para type="description">Do NOT verify server's certificate.</para> </summary> </member> <member name="T:psCheckPoint.IA.GetCheckPointIdentity"> <IA cmd="show-identity">Get-CheckPointIdentity</IA> <summary> <para type="synopsis">Queries the Identity Awareness associations of a given IP.</para> <para type="description"></para> </summary> <example> <code>Get-CheckPointIdentity -Gateway 192.168.1.1 -SharedSecret *** -NoCertificateValidation -IPAddress 192.168.1.2</code> </example> </member> <member name="P:psCheckPoint.IA.GetCheckPointIdentity.IPAddress"> <summary> <para type="description">Identity IP</para> </summary> </member> <member name="M:psCheckPoint.IA.GetCheckPointIdentity.BeginProcessing"> <summary> Provides a one-time, preprocessing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.GetCheckPointIdentity.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.GetCheckPointIdentity.EndProcessing"> <summary> Provides a one-time, post-processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.IA.GetIdentity"> <summary> Stores identity IP to get ready for serialization to JSON request. </summary> </member> <member name="T:psCheckPoint.IA.GetIdentityResponse"> <summary> <para type="synopsis">Response from Get-CheckPointIdentity</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.IPv4Address"> <summary> <para type="description">Queried IPv4 identity</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.IPv6Address"> <summary> <para type="description">Queried IPv6 identity</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.Message"> <summary> <para type="description">Textual description of the command’s result</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.Users"> <summary> <para type="description">All user identities on this IP.</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.Machine"> <summary> <para type="description">Computer name, if available</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.MachineGroups"> <summary> <para type="description">List of computer groups</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.CombinedRoles"> <summary> <para type="description">List of all the access roles on this IP, for auditing and enforcement purposes.</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponse.MachineIdentitySource"> <summary> <para type="description">Machine session’s identity source, if the machine session is available.</para> </summary> </member> <member name="T:psCheckPoint.IA.GetIdentityResponseUser"> <summary> <para type="synopsis">Response from Get-CheckPointIdentity Users parameter</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponseUser.User"> <summary> <para type="description">Users' full names (full name if available, falls back to user name if not)</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponseUser.Groups"> <summary> <para type="description">Array of groups</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponseUser.Roles"> <summary> <para type="description">Array of roles</para> </summary> </member> <member name="P:psCheckPoint.IA.GetIdentityResponseUser.IdentitySource"> <summary> <para type="description">Identity source</para> </summary> </member> <member name="T:psCheckPoint.IA.RemoveCheckPointIdentity"> <IA cmd="delete-identity">Remove-CheckPointIdentity</IA> <summary> <para type="synopsis">Queries the Identity Awareness associations of a given IP.</para> <para type="description"></para> </summary> <example> <code>Remove-CheckPointIdentity -Gateway 192.168.1.1 -SharedSecret *** -NoCertificateValidation -IPAddress 192.168.1.2</code> </example> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.IPAddress"> <summary> <para type="description">Association IP. Required when you revoke a single IP.</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.Subnet"> <summary> <para type="description">Subnet. Required when the revoke method is mask.</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.SubnetMask"> <summary> <para type="description">Subnet mask. Required when the revoke method is mask.</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.IPAddressFirst"> <summary> <para type="description">First IP in the range.Required when the revoke method is range.</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.IPAddressLast"> <summary> <para type="description">Last IP in the range. Required when the revoke method is range.</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveCheckPointIdentity.ClientType"> <summary> <para type="description">Deletes only associations created by the specified identity source.If no value is set for the client-type parameter, or if it is set to any, the gateway deletes all identities associated with the given IP(or IPs)</para> <para type="description">Note - When the client-type is set to vpn(remote access), the gateway deletes all the identities associated with the given IP(or IPs). This is because when you delete an identity associated with an office mode IP, this usually means that this office mode IP is no longer valid.</para> </summary> </member> <member name="M:psCheckPoint.IA.RemoveCheckPointIdentity.BeginProcessing"> <summary> Provides a one-time, preprocessing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.RemoveCheckPointIdentity.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="M:psCheckPoint.IA.RemoveCheckPointIdentity.EndProcessing"> <summary> Provides a one-time, post-processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.IA.RemoveIdentity"> <summary> Stores identity to be removed ready for serialization to JSON request </summary> </member> <member name="T:psCheckPoint.IA.RemoveIdentityResponse"> <summary> <para type="synopsis">Response from Remove-CheckPointIdentity</para> <para type="description"></para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveIdentityResponse.IPv4Address"> <summary> <para type="description">Deleted IPv4 association</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveIdentityResponse.IPv6Address"> <summary> <para type="description">Deleted IPv6 association</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveIdentityResponse.Message"> <summary> <para type="description">Textual description of the command’s result</para> </summary> </member> <member name="P:psCheckPoint.IA.RemoveIdentityResponse.Count"> <summary> <para type="description">Number of deleted identities</para> </summary> </member> <member name="T:psCheckPoint.IA.SwitchJsonConverter"> <summary> Handles converting JSON string values into a System.Management.Automation.SwitchParameter data type. In this case outputting the NOT value as we using NO switch parameters. </summary> </member> <member name="M:psCheckPoint.IA.SwitchJsonConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="M:psCheckPoint.IA.SwitchJsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns> The object value. </returns> </member> <member name="M:psCheckPoint.IA.SwitchJsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param><param name="value">The value.</param><param name="serializer">The calling serializer.</param> </member> <member name="T:psCheckPoint.MembershipActions"> <summary> <para type="description">Action to take when changing membership of object.</para> </summary> </member> <member name="F:psCheckPoint.MembershipActions.Replace"> <summary>Replace existing membership with new items</summary> </member> <member name="F:psCheckPoint.MembershipActions.Add"> <summary>Add new items to existing membership</summary> </member> <member name="F:psCheckPoint.MembershipActions.Remove"> <summary>Remove items from existing membership</summary> </member> <member name="T:psCheckPoint.CheckPointCmdlet`1"> <summary> <para type="description">Base class for other Cmdlets that call a Web-API</para> </summary> </member> <member name="P:psCheckPoint.CheckPointCmdlet`1.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.CheckPointCmdlet`1.Session"> <summary> <para type="description">Session object from Open-CheckPointSession</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdlet`1.GetJSON"> <summary> <para type="description">Returns valid JSON request data</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdlet`1.ProcessRecordResponse(System.String)"> <summary> <para type="description">Process results from the Web-API call</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdlet`1.ProcessRecord"> <summary> <para type="description">Standard method for calling Check Point Web-API commands and processing the results.</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdlet`1.CreateArray(System.String[])"> <summary> <para type="description">Used by Cmdlet parameters that accept arrays</para> <para type="description">Allows arrays to also be accepted in CSV format with either a , (comma) or ; (semicolon) separator.</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdlet`1.ProcessGroupAction(psCheckPoint.MembershipActions,System.String[])"> <summary> <para type="description">Used OnSerializing Events in Set methods to control how set will process groups based on action.</para> </summary> </member> <member name="T:psCheckPoint.CheckPointMessage"> <summary> <para type="description">Simple message result from command</para> </summary> </member> <member name="M:psCheckPoint.CheckPointMessage.#ctor(System.String)"> <summary> JSON Constructor for Check Point Message </summary> </member> <member name="P:psCheckPoint.CheckPointMessage.Message"> <summary> <para type="description">Message string.</para> </summary> </member> <member name="M:psCheckPoint.CheckPointMessage.ToString"> <summary> <para type="description">Returns base message as string</para> </summary> </member> <member name="T:psCheckPoint.CheckPointErrorDetail"> <summary> <para type="description">Extra details of errors or warnings</para> </summary> </member> <member name="M:psCheckPoint.CheckPointErrorDetail.#ctor(System.String,System.Boolean)"> <summary> JSON Constructor for Errors </summary> </member> <member name="P:psCheckPoint.CheckPointErrorDetail.CurrentSession"> <summary> <para type="description">Validation related to the current session.</para> </summary> </member> <member name="T:psCheckPoint.CheckPointError"> <summary> <para type="description">Result when commands return an error.</para> </summary> </member> <member name="M:psCheckPoint.CheckPointError.#ctor(System.String,System.String,psCheckPoint.CheckPointErrorDetail[],psCheckPoint.CheckPointErrorDetail[],psCheckPoint.CheckPointErrorDetail[])"> <summary> Constructor for Check Point Error. Normally only called by JsonConvert.DeserializeObject when there is an error returned. </summary> </member> <member name="P:psCheckPoint.CheckPointError.Code"> <summary> <para type="description">Error code.</para> </summary> </member> <member name="P:psCheckPoint.CheckPointError.Warnings"> <summary> <para type="description">Validation warnings.</para> </summary> </member> <member name="P:psCheckPoint.CheckPointError.Errors"> <summary> <para type="description">Validation errors.</para> </summary> </member> <member name="P:psCheckPoint.CheckPointError.BlockingErrors"> <summary> <para type="description">Validation blocking-errors.</para> </summary> </member> <member name="T:psCheckPoint.CheckPointColorCmdlet`1"> <summary> <para type="description">Base class for other Cmdlets that call a Web-API that need standard Color parameter</para> </summary> </member> <member name="P:psCheckPoint.CheckPointColorCmdlet`1.Color"> <summary> <para type="description">Color of the object. Should be one of existing colors.</para> </summary> </member> <member name="T:psCheckPoint.Extra.Export.CheckPointExportSet"> <summary> <para type="synopsis">Result of Export-CheckPointObjects.</para> <para type="description">Contains arrays of all exported objects including rules, groups, hosts, etc</para> <para type="description">Any unknown exported object will have summary in "Other" array</para> <para type="description">Pipe this to other commands like ConvertTo-CheckPointHtml or ConvertToJson for final export results</para> </summary> <example> <code>$Export | ConvertTo-CheckPointHtml -Open</code> </example> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.AccessRules"> <summary> <para type="synopsis">List of exported Access Rules.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.AddressRanges"> <summary> <para type="synopsis">List of exported Address Ranges.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.Groups"> <summary> <para type="synopsis">List of exported Groups.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.GroupsWithExclusion"> <summary> <para type="synopsis">List of exported Groups with Exclusion.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.Hosts"> <summary> <para type="synopsis">List of exported Hosts.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.MulticastAddressRanges"> <summary> <para type="synopsis">List of exported Multicast Address Ranges.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.Networks"> <summary> <para type="synopsis">List of exported Networks.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.Services"> <summary> <para type="synopsis">List of exported Services.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.ServiceGroups"> <summary> <para type="synopsis">List of exported Service Groups.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.CheckPointExportSet.Other"> <summary> <para type="synopsis">List of exported objects not currently fully implemented in psCheckPoint.</para> </summary> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeAccessRules"> <summary> Conditional Property Serialization for Rules </summary> <returns>true if Rules should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeAddressRanges"> <summary> Conditional Property Serialization for Address Ranges </summary> <returns>true if AddressRanges should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeGroups"> <summary> Conditional Property Serialization for Groups </summary> <returns>true if Groups should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeGroupsWithExclusion"> <summary> Conditional Property Serialization for Groups with Exclusion </summary> <returns>true if GroupsWithExclusion should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeHosts"> <summary> Conditional Property Serialization for Hosts </summary> <returns>true if Hosts should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeMulticastAddressRanges"> <summary> Conditional Property Serialization for Multicast Address Ranges </summary> <returns>true if MulticastAddressRanges should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeNetworks"> <summary> Conditional Property Serialization for Networks </summary> <returns>true if Networks should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeServices"> <summary> Conditional Property Serialization for Services </summary> <returns>true if Services should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeServiceGroups"> <summary> Conditional Property Serialization for Service Groups </summary> <returns>true if ServiceGroups should be serialised.</returns> </member> <member name="M:psCheckPoint.Extra.Export.CheckPointExportSet.ShouldSerializeOther"> <summary> Conditional Property Serialization for Other </summary> <returns>true if Other should be serialised.</returns> </member> <member name="T:psCheckPoint.Extra.Export.ConvertToCheckPointHtml"> <extra category="Export Commands">ConvertTo-CheckPointHtml</extra> <summary> <para type="synopsis">Convert output from Export-CheckPointObjects to a HTML file.</para> <para type="description">Pipe results from Export-CheckPointObjects to here to create a HTML report of the exported data.</para> </summary> <example> <code>Export-CheckPointObjects -Verbose $InputObject | ConvertTo-CheckPointHtml -Open</code> </example> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.Export"> <summary> <para type="description">Export set from Export-CheckPointObjects</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.Out"> <summary> <para type="description">Filename to write HTML file to.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.Open"> <summary> <para type="description">Open file afterwards in default browser.</para> <para type="description">If no filename provides then temp file will be created.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.Template"> <summary> <para type="description">Filename to HTML file to use as template.</para> <para type="description">{JSON} will be replaced with JSON data.</para> <para type="description">Leave blank to use default template.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.IndentedJson"> <summary> <para type="description">Indent the JSON data in the HTML output.</para> <para type="description">This will force the use of "Template Literals" which requires an ES6 compatible browser. (`{JSON}`)</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.EscapeJson"> <summary> <para type="description">Escape JSON text before inserting into HTML file.</para> <para type="description">Automatically turned on if template uses double quotes to define location for JSON. ("{JSON}")</para> </summary> </member> <member name="M:psCheckPoint.Extra.Export.ConvertToCheckPointHtml.ProcessRecord"> <summary> <para type="description">Convert export set to JSON and insert into HTML template for output.</para> </summary> </member> <member name="T:psCheckPoint.Extra.Export.ExportCheckPointObjects"> <extra category="Export Commands">Export-CheckPointObjects</extra> <summary> <para type="synopsis">Export input objects and any other object used by input objects.</para> <para type="description">Performs an export of input objects and any object used by an input object.</para> <para type="description">Input objects could be of the following types:</para> <para type="description"> * Any Check Point Object like Host, Network, Rule, etc</para> <para type="description"> * Output from Get-CheckPointWhereUsed</para> <para type="description"> * Output from Get-CheckPointObjects</para> <para type="description"> * An array or list of objects of any mixture of above</para> </summary> <example> <code>Export-CheckPointObjects -Verbose $InputObject1 $InputObject2 ... $InputObjectX | ConvertTo-CheckPointHtml -Open</code> </example> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.Session"> <summary> <para type="description">Session object from Open-CheckPointSession</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.Object"> <summary> <para type="description">Input objects to start export from.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.Depth"> <summary> <para type="description">Max depth to look for objects used by input objects</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.ExcludeByName"> <summary> <para type="description">Enter names of objects to exclude from export</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.ExcludeByType"> <summary> <para type="description">Enter types of objects to exclude from export</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.ExcludeDetailsByName"> <summary> <para type="description">Enter names of objects you do not want export to search for children of</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.ExcludeDetailsByType"> <summary> <para type="description">Enter types of objects you do not want export to search for children of</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.SkipWhereUsed"> <summary> <para type="description">Even if input object is not a rule do not perform a where used</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.IndirectWhereUsed"> <summary> <para type="description">When passing Check Point objects as input perform a indirect where used instead of the standard direct only.</para> </summary> </member> <member name="M:psCheckPoint.Extra.Export.ExportCheckPointObjects.ProcessRecord"> <summary> <para type="synopsis">Process each input object.</para> </summary> </member> <member name="M:psCheckPoint.Extra.Export.ExportCheckPointObjects.EndProcessing"> <summary> <para type="synopsis">Write out resulting export set object.</para> </summary> </member> <member name="T:psCheckPoint.NewCheckPointCmdlet`1"> <summary> <para type="description">Base class for New-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.Name"> <summary> <para type="description">Object name. Should be unique in the domain.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.Tags"> <summary> <para type="description">Collection of tag identifiers.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.DetailsLevel"> <summary> <para type="description">The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.IgnoreWarnings"> <summary> <para type="description">Apply changes ignoring warnings.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.IgnoreErrors"> <summary> <para type="description">Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet`1.PassThru"> <summary> <para type="description">Return the updated object.</para> </summary> </member> <member name="T:psCheckPoint.Session.CheckPointSession"> <summary> <para type="synopsis">Response from Open-CheckPointSession</para> <para type="description">Used across other Check Point Web API Calls</para> </summary> </member> <member name="M:psCheckPoint.Session.CheckPointSession.#ctor(System.String,System.String,System.String,psCheckPoint.Objects.CheckPointTime,System.Boolean,System.Int32,System.Boolean,System.String,System.String)"> <summary> JSON Constructor for logged in Check Point Session </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.SID"> <summary> <para type="description">Session unique identifier.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.APIServerVersion"> <summary> <para type="description">API Server version.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.DiskSpaceMessage"> <summary> <para type="description">Information about the available disk space on the management server.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.LastLoginWasAt"> <summary> <para type="description">Timestamp when administrator last accessed the management server.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.ReadOnly"> <summary> <para type="description">True if this session is read only.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.SessionTimeout"> <summary> <para type="description">Session expiration timeout in seconds.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.Standby"> <summary> <para type="description">True if this management server is in the standby mode.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.UID"> <summary> <para type="description">Session object unique identifier. This identifier may be used in the discard API to discard changes that were made in this session, when administrator is working from another session, or in the 'switch-session' API.</para> </summary> </member> <member name="P:psCheckPoint.Session.CheckPointSession.URL"> <summary> <para type="description">URL that was used to reach the API server.</para> </summary> </member> <member name="T:psCheckPoint.Session.SendCheckPointKeepAlive"> <api cmd="keepalive">Send-CheckPointKeepAlive</api> <summary> <para type="synopsis">Keep the session valid/alive.</para> <para type="description"></para> </summary> <example> <code>Send-CheckPointKeepAlive</code> </example> </member> <member name="P:psCheckPoint.Session.SendCheckPointKeepAlive.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Session.PublishCheckPointSession"> <api cmd="publish">Publish-CheckPointSession</api> <summary> <para type="synopsis">All the changes done by this user will be seen by all users only after publish is called.</para> <para type="description"></para> </summary> <example> <code>Publish-CheckPointSession</code> </example> </member> <member name="P:psCheckPoint.Session.PublishCheckPointSession.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Session.PublishCheckPointSession.PublishSession"> <summary> <para type="description">Publish none active session</para> </summary> </member> <member name="P:psCheckPoint.Session.PublishCheckPointSession.UID"> <summary> <para type="description">Publish none active session UID</para> </summary> </member> <member name="T:psCheckPoint.Session.ResetCheckPointSession"> <api cmd="discard">Reset-CheckPointSession</api> <summary> <para type="synopsis">Log out of a session.</para> <para type="description"></para> </summary> <example> <code>Reset-CheckPointSession</code> </example> </member> <member name="P:psCheckPoint.Session.ResetCheckPointSession.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="P:psCheckPoint.Session.ResetCheckPointSession.ResetSession"> <summary> <para type="description">Reset none active session</para> </summary> </member> <member name="P:psCheckPoint.Session.ResetCheckPointSession.UID"> <summary> <para type="description">Reset none active session UID</para> </summary> </member> <member name="T:psCheckPoint.Session.CloseCheckPointSession"> <api cmd="logout">Close-CheckPointSession</api> <api cmd="continue-session-in-smartconsole">Close-CheckPointSession</api> <summary> <para type="synopsis">Log out of a session.</para> <para type="description"></para> </summary> <example> <code>Close-CheckPointSession</code> </example> </member> <member name="P:psCheckPoint.Session.CloseCheckPointSession.ContinueSessionInSmartconsole"> <summary> <para type="description">The session will be continued next time your open SmartConsole. In case 'uid' is not provided, use current session. In order for the session to pass successfully to SmartConsole, make sure you don't have any other active GUI sessions.</para> </summary> </member> <member name="P:psCheckPoint.Session.CloseCheckPointSession.Command"> <summary> <para type="description">Check Point Web-API command that should be called.</para> </summary> </member> <member name="T:psCheckPoint.Session.OpenCheckPointSession"> <api cmd="login">Open-CheckPointSession</api> <summary> <para type="synopsis">Log in to the server with user name and password.</para> <para type="description"></para> </summary> <example> <code>Open-CheckPointSession -ManagementServer 192.168.1.1</code> </example> <example> <code>$Session = Open-CheckPointSession -ManagementServer 192.168.1.1 -PassThru</code> </example> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.ManagementServer"> <summary> <para type="description">IP or Hostname of the Check point Management Server</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.ManagementPort"> <summary> <para type="description">Port Web API running on. Default: 443</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.Credentials"> <summary> <para type="description">PSCredential containing User name and Password. If not provided you will be prompted.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.ReadOnly"> <summary> <para type="description">Login with Read Only permissions. This parameter is not considered in case continue-last-session is true.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.ContinueLastSession"> <summary> <para type="description">The new session would continue where the last session was stopped.</para> <para type="description">This option is available when the administrator has only one session that can be continued.</para> <para type="description">If there is more than one session, see 'switch-session' API.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.Domain"> <summary> <para type="description">Use domain to login to specific domain. Domain can be identified by name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.EnterLastPublishedSession"> <summary> <para type="description">Login to the last published session. Such login is done with the Read Only permissions.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.SessionComments"> <summary> <para type="description">Session comments.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.SessionDescription"> <summary> <para type="description">Session description.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.SessionName"> <summary> <para type="description">Session unique name.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.SessionTimeout"> <summary> <para type="description">Session expiration timeout in seconds. Default 600 seconds.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.NoCertificateValidation"> <summary> <para type="description">Do NOT verify server's certificate.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.NoCompression"> <summary> <para type="description">Do not enable HTTP compression.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.PassThru"> <summary> <para type="description">Return the session and do not store it for automatic use.</para> </summary> </member> <member name="M:psCheckPoint.Session.OpenCheckPointSession.ProcessRecord"> <summary> Provides a record-by-record processing functionality for the cmdlet. </summary> </member> <member name="T:psCheckPoint.SwitchJsonConverter"> <summary> Handles converting JSON string values into a System.Management.Automation.SwitchParameter data type. </summary> </member> <member name="M:psCheckPoint.SwitchJsonConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="M:psCheckPoint.SwitchJsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns> The object value. </returns> </member> <member name="M:psCheckPoint.SwitchJsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param><param name="value">The value.</param><param name="serializer">The calling serializer.</param> </member> </members> </doc> |