netstandard1.6/psCheckPoint.xml
<?xml version="1.0"?>
<doc> <assembly> <name>psCheckPoint</name> </assembly> <members> <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.CheckPointCmdletBase"> <summary> <para type="description">Base class for other Cmdlets that call a Web-API</para> </summary> </member> <member name="P:psCheckPoint.CheckPointCmdletBase.IsPSSession"> <summary> Gets a value indicating whether this instance's session is sourced from the PowerShell session state or manually supplied by the Cmdlet. </summary> <value><c>true</c> if this instance is from session state; otherwise, <c>false</c>.</value> </member> <member name="P:psCheckPoint.CheckPointCmdletBase.Session"> <summary> <para type="description">Session object from Open-CheckPointSession</para> </summary> </member> <member name="M:psCheckPoint.CheckPointCmdletBase.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.CheckPointCmdletBase.BeginProcessing"> <inheritdoc /> </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-CheckPointObjects</para> <para type="description">* Name of an object</para> <para type="description">* An array or list of objects of any mixture of above</para> </summary> <example> <code> Export-CheckPointObjects $InputObject1 $InputObject2 ... $InputObjectX </code> </example> </member> <member name="T:psCheckPoint.Extra.Export.ExportCheckPointObjects.OutputType"> <summary> <para type="description">Export output type</para> </summary> </member> <member name="F:psCheckPoint.Extra.Export.ExportCheckPointObjects.OutputType.HTML"> <summary> JSON Data embeded in HTML file </summary> </member> <member name="F:psCheckPoint.Extra.Export.ExportCheckPointObjects.OutputType.JSON"> <summary> Raw JSON data </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.CustomIndirectWhereUsed"> <summary> <para type="description"> When passing Check Point objects as input perform a custom indirect where used instead of the standard direct only. </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.Force"> <summary> <para type="description">Force overwritting existing file.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.Indent"> <summary> <para type="description">Indent JSON data</para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.IndirectTypes"> <summary> <para type="description"> Which object types should be followed. If not specified only group types will be followed. </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="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.Output"> <summary> <para type="description">Weather to output raw Json data or HTML.</para> </summary> <value>The output type.</value> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.Path"> <summary> <para type="description">Filename to write HTML file to.</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. NOTE: String inputs will ignore this and still run a Where Used. </para> </summary> </member> <member name="P:psCheckPoint.Extra.Export.ExportCheckPointObjects.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="M:psCheckPoint.Extra.Export.ExportCheckPointObjects.BeginProcessingAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Extra.Export.ExportCheckPointObjects.EndProcessingAsync"> <summary> <para type="synopsis">Write out resulting export set object.</para> </summary> </member> <member name="M:psCheckPoint.Extra.Export.ExportCheckPointObjects.ProcessRecordAsync"> <summary> <para type="synopsis">Process each input object.</para> </summary> </member> <member name="T:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync"> <extra category="Group Sync Commands">Invoke-CheckPointGroupSync</extra> <summary> <para type="synopsis"> Performs a one way sync of external list of group members to a Check Point group. </para> <para type="description"> Performs a one way sync of external list of group members to a Check Point group. </para> </summary> <example> <code> { ... } | Invoke-CheckPointGroupSync -Name MyGroup </code> </example> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Color"> <summary> <para type="description">Color assigned to created objects</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Comments"> <summary> <para type="description">Comments for created objects</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.CreateGroup"> <summary> <para type="description">If group doesn't already exist create it.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.GroupName"> <summary> <para type="description">Name of group to be synced to list of members</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Ignore"> <summary> <para type="description">Used to ignore warnings or errors.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Input"> <summary> <para type="description"> The list of all IPs and subnets that should exist in the group. Group members will be synced with this list. </para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Prefix"> <summary> <para type="description">The host and network object name prefix to use.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Rename"> <summary> <para type="description">If object already exists but with different name, rename it.</para> </summary> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Tags"> <summary> <para type="description">Tags assigned to created objects</para> </summary> </member> <member name="M:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.BeginProcessingAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.EndProcessingAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.ProcessRecordAsync"> <summary> Processes the record. </summary> <exception cref="T:System.Management.Automation.PSInvalidCastException">Incorrect object found.</exception> </member> <member name="T:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions"> <summary> Actions that can be taken by Invoke-CheckPointSync to each group member. </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.NoChange"> <summary> No changes required </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.Rename"> <summary> Renamed existing object </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.Add"> <summary> Added object to group </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.Remove"> <summary> Removed object from group </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.Create"> <summary> Created object and added to group </summary> </member> <member name="F:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Actions.Delete"> <summary> Deleted object no longer required and not used anywhere else </summary> </member> <member name="T:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.SyncOutput"> <summary> <para type="synopsis">Results of Invoke-CheckPointGroupSync.</para> <para type="description">Detailed results of group sync actions taken.</para> </summary> <example> <code> {Input IPs and Subnets} | Invoke-CheckPointGroupSync -Name MyGroup </code> </example> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.SyncOutput.Actions"> <summary> Gets the actions taken. </summary> <value>The actions.</value> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.SyncOutput.Comments"> <summary> Gets the comments. </summary> <value>The comments.</value> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.SyncOutput.Error"> <summary> Gets a value indicating whether an error occured. </summary> <value><c>true</c> if error; otherwise, <c>false</c>.</value> </member> <member name="P:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.SyncOutput.Name"> <summary> Gets the name. </summary> <value>The name.</value> </member> <member name="T:psCheckPoint.Extra.Sync.InvokeCheckPointGroupSync.Member"> <summary> Represents an input IP or Subnet </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.Domain"> <summary> <para type="description">Domain name</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="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.Machine"> <summary> <para type="description">Computer name</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.MachineOS"> <summary> <para type="description">Host operating system. For example: Windows 7.</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.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.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.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.SessionTimeout"> <summary> <para type="description">Timeout (in seconds) for this Identity Awareness association.</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.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="M:psCheckPoint.IA.AddCheckPointIdentity.BeginProcessingAsync"> <summary> Begins the processing asynchronous. </summary> <returns></returns> </member> <member name="M:psCheckPoint.IA.AddCheckPointIdentity.ProcessRecordAsync"> <summary> Processes the record asynchronous. </summary> <returns></returns> </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.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.CertificateHash"> <summary> <para type="description">Server certificate hash you are expecting.</para> </summary> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.CertificateValidation"> <summary> <para type="description">Do NOT verify server's certificate.</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.Session"> <summary> Gets the IA session. </summary> <value>The IA session.</value> </member> <member name="P:psCheckPoint.IA.CheckPointIACmdlet.Tasks"> <summary> Gets the executed processing tasks the EndProcessingAsync will wait for. </summary> <value>The tasks.</value> </member> <member name="M:psCheckPoint.IA.CheckPointIACmdlet.BeginProcessing"> <summary> Begins the processing. </summary> </member> <member name="M:psCheckPoint.IA.CheckPointIACmdlet.EndProcessingAsync"> <summary> Ends the processing asynchronous. </summary> <returns></returns> </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.BeginProcessingAsync"> <summary> Begins the processing asynchronous. </summary> <returns></returns> </member> <member name="M:psCheckPoint.IA.GetCheckPointIdentity.ProcessRecordAsync"> <summary> Processes the record asynchronous. </summary> <returns></returns> </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.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="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.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.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="M:psCheckPoint.IA.RemoveCheckPointIdentity.BeginProcessingAsync"> <summary> Begins the processing asynchronous. </summary> <returns></returns> </member> <member name="M:psCheckPoint.IA.RemoveCheckPointIdentity.ProcessRecordAsync"> <summary> Processes the record asynchronous. </summary> <returns></returns> </member> <member name="T:psCheckPoint.NewCheckPointCmdlet"> <summary> <para type="description">Base class for New-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.NewCheckPointCmdlet.Name"> <summary> <para type="description">Object name. Should be unique in the domain.</para> </summary> </member> <member name="M:psCheckPoint.NewCheckPointCmdlet.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </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="M:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayer.ProcessRecordAsync"> <inheritdoc /> </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="M:psCheckPoint.Objects.AccessLayer.GetCheckPointAccessLayers.ProcessRecordAsync"> <inheritdoc /> </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.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="M:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AccessLayer.NewCheckPointAccessLayer.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </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.AccessLayer"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessLayer.RemoveCheckPointAccessLayer.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AccessLayer.RemoveCheckPointAccessLayer.Remove(System.String)"> <inheritdoc /> </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.AccessLayer"> <summary> <para type="description">Network object, name or UID.</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="P:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AccessLayer.SetCheckPointAccessLayer.Set(System.String)"> <inheritdoc /> </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> <para type="description"></para> </summary> <example> <code> Get-CheckPointAccessRule -Layer Network -RuleNumber 1 </code> </example> </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="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.RuleNumber"> <summary> <para type="description">Rule number.</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRule.ProcessRecordAsync"> <inheritdoc /> </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> <example> <code> Get-CheckPointAccessRuleBase -AccessLayer Network </code> </example> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.AccessLayer"> <summary> <para type="description">Network object, name or UID.</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.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.Limit"> <summary> <para type="description">No more than that many results will be returned.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.Offset"> <summary> <para type="description">Skip that many results before beginning to return them.</para> </summary> </member> <member name="M:psCheckPoint.Objects.AccessRule.GetCheckPointAccessRuleBase.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRange"> <api cmd="show-address-range">Get-CheckPointAddressRange</api> <summary> <para type="synopsis">Retrieve existing address range using name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointAddressRange -Name Range1 </code> </example> </member> <member name="M:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRange.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRanges"> <api cmd="show-address-ranges">Get-CheckPointAddressRanges</api> <summary> <para type="synopsis">Retrieve all address ranges.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointAddressRanges </code> </example> </member> <member name="M:psCheckPoint.Objects.AddressRange.GetCheckPointAddressRanges.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange"> <api cmd="add-address-range">New-CheckPointAddressRange</api> <summary> <para type="synopsis">Create new address range.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointAddressRange -Name Range1 -IPAddressFirst 192.168.1.2 -IPAddressLast 192.168.1.5 </code> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</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="M:psCheckPoint.Objects.AddressRange.NewCheckPointAddressRange.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange"> <api cmd="delete-address-range">Remove-CheckPointAddressRange</api> <summary> <para type="synopsis">Delete existing address range using name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointAddressRange -Name Range1 </code> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange.AddressRange"> <summary> <para type="description">Address Range object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AddressRange.RemoveCheckPointAddressRange.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange"> <api cmd="set-address-range">Set-CheckPointAddressRange</api> <summary> <para type="synopsis">Edit existing address range using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointAddressRange -Name Range1 -NewName RangeA -Color Red </code> </example> </member> <member name="P:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.AddressRange"> <summary> <para type="description">Address Range object, name or UID.</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="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.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.AddressRange.SetCheckPointAddressRange.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ApplicationCategory.GetCheckPointApplicationCategories"> <api cmd="show-application-site-categories">Get-CheckPointApplicationCategories</api> <summary> <para type="synopsis">Retrieve all Application Categories.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointApplicationCategories </code> </example> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.GetCheckPointApplicationCategories.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ApplicationCategory.GetCheckPointApplicationCategory"> <api cmd="show-application-site-category">Get-CheckPointApplicationCategory</api> <summary> <para type="synopsis">Retrieve existing Application Category using name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointApplicationCategory -Name "Low Risk" </code> </example> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.GetCheckPointApplicationCategory.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ApplicationCategory.NewCheckPointApplicationCategory"> <api cmd="add-application-site-category">New-CheckPointApplicationCategory</api> <summary> <para type="synopsis">Create new Application Category.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointApplicationCategory -Name MyCategory </code> </example> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.NewCheckPointApplicationCategory.Description"> <summary> <para type="description">A description for the application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.NewCheckPointApplicationCategory.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.NewCheckPointApplicationCategory.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.NewCheckPointApplicationCategory.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ApplicationCategory.RemoveCheckPointApplicationCategory"> <api cmd="delete-application-site-category">Remove-CheckPointApplicationCategory</api> <summary> <para type="synopsis">Delete existing object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointApplicationCategory -Name MyCategory </code> </example> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.RemoveCheckPointApplicationCategory.ApplicationCategory"> <summary> <para type="description">Application Category object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.RemoveCheckPointApplicationCategory.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.RemoveCheckPointApplicationCategory.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication"> <api cmd="set-application-site-category">Set-CheckPointApplicationCategory</api> <summary> <para type="synopsis">Edit existing Application Category using name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointApplicationCategory -Name MyCategory -Color Red </code> </example> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication.ApplicationCategory"> <summary> <para type="description">Group object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication.Description"> <summary> <para type="description">A description for the application.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ApplicationCategory.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.ApplicationCategory.SetCheckPointApplication.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ApplicationCategory.SetCheckPointApplication.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Application.GetCheckPointApplication"> <api cmd="show-application-site">Get-CheckPointApplication</api> <summary> <para type="synopsis">Retrieve existing Application Site using name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointApplication -Name "Check Point User Center" </code> </example> </member> <member name="M:psCheckPoint.Objects.Application.GetCheckPointApplication.ProcessRecordAsync"> <inheritdoc /> </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 applications.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointApplications </code> </example> </member> <member name="M:psCheckPoint.Objects.Application.GetCheckPointApplications.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Application.NewCheckPointApplication"> <api cmd="add-application-site">New-CheckPointApplication</api> <summary> <para type="synopsis">Create new application.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointApplication -Name MyApp -PrimaryCategory "Low Risk" -UrlList www.google.com,www.bing.com </code> </example> </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.ApplicationSignature"> <summary> <para type="description">Application signature generated by Signature Tool.</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.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.UrlsDefinedAsRegularExpression"> <summary> <para type="description"> States whether the URL is defined as a Regular Expression or not. </para> </summary> </member> <member name="M:psCheckPoint.Objects.Application.NewCheckPointApplication.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Application.NewCheckPointApplication.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </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> <code> Remove-CheckPointApplication -Name MyApp </code> </example> </member> <member name="P:psCheckPoint.Objects.Application.RemoveCheckPointApplication.ApplicationSite"> <summary> <para type="description">Application Site object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.RemoveCheckPointApplication.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Application.RemoveCheckPointApplication.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Application.SetCheckPointApplication"> <api cmd="set-application-site">Set-CheckPointApplication</api> <summary> <para type="synopsis">Edit existing application using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointApplication -Name MyApp -Color Red </code> </example> </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.AdditionalCategoriesAction"> <summary> <para type="description">Action to take with Additional Categories.</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.ApplicationSignatureAction"> <summary> <para type="description">Action to take with Application Signatures.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.ApplicationSite"> <summary> <para type="description">Group object, name or UID.</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.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.UrlsDefinedAsRegularExpression"> <summary> <para type="description"> States whether the URL is defined as a Regular Expression or not. </para> </summary> </member> <member name="P:psCheckPoint.Objects.Application.SetCheckPointApplication.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Application.SetCheckPointApplication.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Application.SetCheckPointApplication.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </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"> Use this to return the full object details if you only got summary currently. </para> </summary> <example> <code> Get-CheckPointGroups | Get-CheckPointFullObject </code> </example> </member> <member name="P:psCheckPoint.Objects.GetCheckPointFullObject.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.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.GetCheckPointObject"> <summary> <para type="description">Base class for Get-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObject.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.GetCheckPointObject.Value"> <summary> <para type="description">Object name or UID.</para> </summary> </member> <member name="M:psCheckPoint.Objects.GetCheckPointObject.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GetCheckPointObjects"> <summary> <para type="description">Base class for Get-CheckPoint*ObjectName*s classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjects.All"> <summary> <para type="description">Get All Records</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjects.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.GetCheckPointObjects.Limit"> <summary> <para type="description">No more than that many results will be returned.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GetCheckPointObjects.Offset"> <summary> <para type="description">Skip that many results before beginning to return them.</para> </summary> </member> <member name="M:psCheckPoint.Objects.GetCheckPointObjects.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupsWithExclusion"> <api cmd="show-groups-with-exclusion">Get-CheckPointGroupsWithExclusion</api> <summary> <para type="synopsis">Retrieve all Groups with Exclusion.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointGroupsWithExclusion </code> </example> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupsWithExclusion.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupWithExclusion"> <api cmd="show-group-with-exclusion">Get-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Retrieve existing Group with Exclusion using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointGroupWithExclusion -Name MyGroupWithExclusion </code> </example> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.GetCheckPointGroupWithExclusion.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion"> <api cmd="add-group-with-exclusion">New-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Create new Group with Exclusion.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointGroupWithExclusion -Name MyGroupWithExclusion -Include GroupA -Except GroupB </code> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.Except"> <summary> <para type="description">Object to exclude.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.Include"> <summary> <para type="description">Object to include.</para> </summary> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.NewCheckPointGroupWithExclusion.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion"> <api cmd="delete-group-with-exclusion">Remove-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Delete existing Group with Exclusion using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointGroupWithExclusion -Name MyGroupWithExclusion </code> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion.GroupWithExclusion"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.RemoveCheckPointGroupWithExclusion.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion"> <api cmd="set-group-with-exclusion">Set-CheckPointGroupWithExclusion</api> <summary> <para type="synopsis">Edit existing Group with Exclusion using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointGroupWithExclusion -Name MyGroupWithExclusion -Color Red </code> </example> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.Except"> <summary> <para type="description">Object to exclude.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.GroupWithExclusion"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.Include"> <summary> <para type="description">Object to include.</para> </summary> </member> <member name="P:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.GroupWithExclusion.SetCheckPointGroupWithExclusion.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Group.GetCheckPointGroup"> <api cmd="show-group">Get-CheckPointGroup</api> <summary> <para type="synopsis">Retrieve existing group using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointGroup -Name MyGroup </code> </example> </member> <member name="M:psCheckPoint.Objects.Group.GetCheckPointGroup.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Group.GetCheckPointGroups"> <api cmd="show-groups">Get-CheckPointGroups</api> <summary> <para type="synopsis">Retrieve all groups.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointGroups </code> </example> </member> <member name="M:psCheckPoint.Objects.Group.GetCheckPointGroups.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Group.NewCheckPointGroup"> <api cmd="add-group">New-CheckPointGroup</api> <summary> <para type="synopsis">Create new group.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointGroup -Name MyGroup -Members HostA,HostB,HostC </code> </example> </member> <member name="P:psCheckPoint.Objects.Group.NewCheckPointGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.NewCheckPointGroup.Members"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Group.NewCheckPointGroup.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Group.RemoveCheckPointGroup"> <api cmd="delete-group">Remove-CheckPointGroup</api> <summary> <para type="synopsis">Delete existing group using name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointGroup -Name MyGroup </code> </example> </member> <member name="P:psCheckPoint.Objects.Group.RemoveCheckPointGroup.Group"> <summary> <para type="description">Group object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Group.RemoveCheckPointGroup.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Group.RemoveCheckPointGroup.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Group.SetCheckPointGroup"> <api cmd="set-group">Set-CheckPointGroup</api> <summary> <para type="synopsis">Edit existing group using name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointGroup -Name MyGroup -MemberAction Add -Members HostD </code> </example> </member> <member name="P:psCheckPoint.Objects.Group.SetCheckPointGroup.Group"> <summary> <para type="description">Group object, name or UID.</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="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.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Group.SetCheckPointGroup.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Group.SetCheckPointGroup.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Host.GetCheckPointHost"> <api cmd="show-host">Get-CheckPointHost</api> <summary> <para type="synopsis">Retrieve existing host using name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointHost -Name MyHost </code> </example> </member> <member name="M:psCheckPoint.Objects.Host.GetCheckPointHost.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Host.GetCheckPointHosts"> <api cmd="show-hosts">Get-CheckPointHosts</api> <summary> <para type="synopsis">Retrieve all Hosts.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointHosts </code> </example> </member> <member name="M:psCheckPoint.Objects.Host.GetCheckPointHosts.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Host.NewCheckPointHost"> <api cmd="add-host">New-CheckPointHost</api> <summary> <para type="synopsis">Create new host.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointHost -Name MyHost -IPAddress 1.2.3.4 </code> </example> </member> <member name="P:psCheckPoint.Objects.Host.NewCheckPointHost.Groups"> <summary> <para type="description">Collection of group identifiers.</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="M:psCheckPoint.Objects.Host.NewCheckPointHost.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Host.RemoveCheckPointHost"> <api cmd="delete-host">Remove-CheckPointHost</api> <summary> <para type="synopsis">Delete existing host using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointHost -Name MyHost </code> </example> </member> <member name="P:psCheckPoint.Objects.Host.RemoveCheckPointHost.Host"> <summary> <para type="description">Host object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Host.RemoveCheckPointHost.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Host.RemoveCheckPointHost.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Host.SetCheckPointHost"> <api cmd="set-host">Set-CheckPointHost</api> <summary> <para type="synopsis">Edit existing host using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointHost -Name MyHost -NewName HostA -Tags MyTag </code> </example> </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="P:psCheckPoint.Objects.Host.SetCheckPointHost.Host"> <summary> <para type="description">Host object, name or UID.</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.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Host.SetCheckPointHost.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Host.SetCheckPointHost.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointObject"> <api cmd="show-object">Get-CheckPointObject</api> <summary> <para type="synopsis">Get object by UID.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointObject -UID "12345678-1234-1234-1234-123456789abc" </code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObject.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.Misc.GetCheckPointObject.UID"> <summary> <para type="description">Object unique identifier.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.GetCheckPointObject.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointObjects"> <api cmd="show-objects">Get-CheckPointObjects</api> <api cmd="show-unused-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> <example> <code> Get-CheckPointObjects -Unused </code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.All"> <summary> <para type="description">Get All Records</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.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.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.Limit"> <summary> <para type="description">No more than that many results will be returned.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Offset"> <summary> <para type="description">Skip that many results before beginning to return them.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Type"> <summary> <para type="description">The objects' type</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointObjects.Unused"> <summary> <para type="description">Retrieve all unused objects.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.GetCheckPointObjects.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointTask"> <api cmd="show-task">Get-CheckPointTask</api> <summary> <para type="synopsis">Retrieves task details by Task ID</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="M:psCheckPoint.Objects.Misc.GetCheckPointTask.ProcessRecordAsync"> <inheritdoc /> </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.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.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="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Object"> <summary> <para type="description">Check Point Object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.Value"> <summary> <para type="description">Object name or UID.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.GetCheckPointWhereUsed.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom"> <summary> <para type="synopsis">Searches for usage of the target object in other objects and rules.</para> <para type="description"> This is a custom implementation that only makes non-indirect calls to the management server. It than manually follows certain object types to find indirect usages. This allows you to have where-used return less than the standard command in some instances. This will also be depricated if/when the standard Check Point API is updated with similar features. </para> </summary> <example> <code> Get-CheckPointWhereUsedCustom -Name http </code> </example> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.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.Misc.GetCheckPointWhereUsedCustom.Indirect"> <summary> <para type="description">Search for indirect usage.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.IndirectMaxDepth"> <summary> <para type="description">Maximum nesting level during indirect usage search.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.IndirectTypes"> <summary> <para type="description"> Which object types should be followed. If not specified only group types will be followed. </para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.Object"> <summary> <para type="description">Check Point Object.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.Value"> <summary> <para type="description">Object name or UID.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.GetCheckPointWhereUsedCustom.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Misc.InvokeCheckPointScript"> <api cmd="run-script">Invoke-CheckPointScript</api> <summary> <para type="synopsis">Run script on gateways</para> <para type="description"> Run a script on target gateways. After completing you can get any output from script by looking at the task details. </para> </summary> <example> <code> $(Invoke-CheckPointScript -ScriptName "Get Configuration" -Script "clish -c 'Show Configuration'" -Targets mgmt | Wait-CheckPointTask).TaskDetails.ResponseMessage </code> </example> </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.Comments"> <summary> <para type="description">Comments string</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.ScriptName"> <summary> <para type="description">Script Name.</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="M:psCheckPoint.Objects.Misc.InvokeCheckPointScript.ProcessRecordAsync"> <inheritdoc /> </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 </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.Task"> <summary> <para type="description">Unique identifier of task</para> </summary> </member> <member name="P:psCheckPoint.Objects.Misc.WaitCheckPointTask.Timeout"> <summary> <para type="description">Timeout in seconds.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Misc.WaitCheckPointTask.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Misc.WaitCheckPointTask.Wait(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRange"> <api cmd="show-multicast-address-range">Get-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Retrieve existing Multicast Address Range using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointMulticastAddressRanges </code> </example> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRange.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRanges"> <api cmd="show-multicast-address-ranges">Get-CheckPointMulticastAddressRanges</api> <summary> <para type="synopsis">Retrieve all Multicast Address Ranges.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointMulticastAddressRange -Name MyMulticastAR </code> </example> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.GetCheckPointMulticastAddressRanges.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange"> <api cmd="add-multicast-address-range">New-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Create new Multicast Address Range.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointMulticastAddressRange -Name MyMulticastAR -IPAddress 224.5.6.7 </code> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.Groups"> <summary> <para type="description">Collection of group identifiers.</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="M:psCheckPoint.Objects.MulticastAddressRange.NewCheckPointMulticastAddressRange.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange"> <api cmd="delete-multicast-address-range">Remove-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Delete existing Multicast Address Range using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointMulticastAddressRange -Name MyMulticastAR </code> </example> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange.MulticastAddressRange"> <summary> <para type="description">Multicast Address Range object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.RemoveCheckPointMulticastAddressRange.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange"> <api cmd="set-multicast-address-range">Set-CheckPointMulticastAddressRange</api> <summary> <para type="synopsis">Edit existing Multicast Address Range using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointMulticastAddressRange -Name MyMulticastAR -Color Red </code> </example> </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="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.MulticastAddressRange"> <summary> <para type="description">Multicast Address Range object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.MulticastAddressRange.SetCheckPointMulticastAddressRange.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Network.GetCheckPointNetwork"> <api cmd="show-network">Get-CheckPointNetwork</api> <summary> <para type="synopsis">Retrieve existing Network using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointNetwork -Name MyNetwork </code> </example> </member> <member name="M:psCheckPoint.Objects.Network.GetCheckPointNetwork.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Network.GetCheckPointNetworks"> <api cmd="show-networks">Get-CheckPointNetworks</api> <summary> <para type="synopsis">Retrieve all Networks.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointNetworks </code> </example> </member> <member name="M:psCheckPoint.Objects.Network.GetCheckPointNetworks.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Network.NewCheckPointNetwork"> <api cmd="add-network">New-CheckPointNetwork</api> <summary> <para type="synopsis">Create new Network.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointNetwork -Name MyNetwork -Subnet 192.168.100.0 -MaskLength 24 </code> </example> </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="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.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.SubnetMask"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Network.NewCheckPointNetwork.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Network.RemoveCheckPointNetwork"> <api cmd="delete-network">Remove-CheckPointNetwork</api> <summary> <para type="synopsis">Delete existing Network using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointNetwork -Name MyNetwork </code> </example> </member> <member name="P:psCheckPoint.Objects.Network.RemoveCheckPointNetwork.Network"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.RemoveCheckPointNetwork.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Network.RemoveCheckPointNetwork.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Network.SetCheckPointNetwork"> <api cmd="set-network">Set-CheckPointNetwork</api> <summary> <para type="synopsis">Edit existing Network using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointNetwork -Name MyNetwork -NewName MyNetwork2 -Tags MyTag </code> </example> </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="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.Network"> <summary> <para type="description">Network object, name or UID.</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.SubnetMask"> <summary> <para type="description">IPv4 network address.</para> </summary> </member> <member name="P:psCheckPoint.Objects.Network.SetCheckPointNetwork.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Network.SetCheckPointNetwork.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.Network.SetCheckPointNetwork.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.NewCheckPointObject"> <summary> <para type="description">Base class for New-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.Objects.NewCheckPointObject.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.Policy.InstallCheckPointPolicy"> <api cmd="install-policy">Install-CheckPointPolicy</api> <summary> <para type="synopsis">Install policy to gateway(s)</para> <para type="description"></para> </summary> <example> <code> Install-CheckPointPolicy -PolicyPackage MyPolicy -Targets MyGateway -Access -ThreatPrevention </code> </example> </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.PolicyPackage"> <summary> <para type="description">The name of the Policy Package to be installed.</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="M:psCheckPoint.Objects.Policy.InstallCheckPointPolicy.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Policy.TestCheckPointPolicy"> <api cmd="verify-policy">Test-CheckPointPolicy</api> <summary> <para type="synopsis">Verify policy</para> <para type="description"></para> </summary> <example> <code> Test-CheckPointPolicy -PolicyPackage MyPolicy </code> </example> </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="M:psCheckPoint.Objects.Policy.TestCheckPointPolicy.ProcessRecordAsync"> <inheritdoc /> </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.Ignore"> <summary> <para type="description">Apply changes ignoring warnings or errors.</para> </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.InputName"> <summary> Gets the type of object being deleted. </summary> </member> <member name="P:psCheckPoint.Objects.RemoveCheckPointObject.Object"> <summary> <para type="description">Object to delete.</para> </summary> </member> <member name="M:psCheckPoint.Objects.RemoveCheckPointObject.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.RemoveCheckPointObject.Remove(System.String)"> <summary> Removes the specified object. </summary> <param name="value">The name or UID of the object to remove.</param> </member> <member name="T:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZone"> <api cmd="show-security-zone">Get-CheckPointSecurityZone</api> <summary> <para type="synopsis">Retrieve existing Security Zone using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointSecurityZone -Name MyZone </code> </example> </member> <member name="M:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZone.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZones"> <api cmd="show-security-zones">Get-CheckPointSecurityZones</api> <summary> <para type="synopsis">Retrieve all Security Zones.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointSecurityZones </code> </example> </member> <member name="M:psCheckPoint.Objects.SecurityZone.GetCheckPointSecurityZones.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SecurityZone.NewCheckPointSecurityZone"> <api cmd="add-security-zone">New-CheckPointSecurityZone</api> <summary> <para type="synopsis">Create new Security Zone.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointSecurityZone -Name MyZone </code> </example> </member> <member name="M:psCheckPoint.Objects.SecurityZone.NewCheckPointSecurityZone.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone"> <api cmd="delete-security-zone">Remove-CheckPointSecurityZone</api> <summary> <para type="synopsis">Delete existing Security Zone using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointSecurityZone -Name MyZone </code> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone.SecurityZone"> <summary> <para type="description">Security Zone object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.SecurityZone.RemoveCheckPointSecurityZone.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone"> <api cmd="set-security-zone">Set-CheckPointSecurityZone</api> <summary> <para type="synopsis">Edit existing Security Zone using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointSecurityZone -Name MyZone -Comments "This is my zone" </code> </example> </member> <member name="P:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone.SecurityZone"> <summary> <para type="description">Security Zone object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.SecurityZone.SetCheckPointSecurityZone.Set(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroup"> <api cmd="show-service-group">Get-CheckPointServiceGroup</api> <summary> <para type="synopsis">Retrieve existing Service Group using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointGroup -Name MyServices </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroup.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroups"> <api cmd="show-service-groups">Get-CheckPointServiceGroups</api> <summary> <para type="synopsis">Retrieve all Service Groups.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointServiceGroups </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.GetCheckPointServiceGroups.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup"> <api cmd="add-service-group">New-CheckPointServiceGroup</api> <summary> <para type="synopsis">Create new Service Group.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointServiceGroup -Name MyServices -Members DNS,HTTP,HTTPS </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.Members"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.NewCheckPointServiceGroup.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup"> <api cmd="delete-service-group">Remove-CheckPointServiceGroup</api> <summary> <para type="synopsis">Delete existing Service Group using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointGroup -Name MyServices </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup.ServiceGroup"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.RemoveCheckPointServiceGroup.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup"> <api cmd="set-service-group">Set-CheckPointServiceGroup</api> <summary> <para type="synopsis">Edit existing Service Group using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointGroup -Name MyServices -NewName MyServiceGroup </code> </example> </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="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.ServiceGroup"> <summary> <para type="description">Group object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceGroup.SetCheckPointServiceGroup.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.GetCheckPointServicesTCP"> <api cmd="show-services-tcp">Get-CheckPointServicesTCP</api> <summary> <para type="synopsis">Retrieve all TCP objects.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointServicesTCP </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.GetCheckPointServicesTCP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.GetCheckPointServiceTCP"> <api cmd="show-service-tcp">Get-CheckPointServiceTCP</api> <summary> <para type="synopsis">Retrieve existing TCP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointServiceTCP -Name MyTCP </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.GetCheckPointServiceTCP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP"> <api cmd="add-service-tcp">New-CheckPointServiceTCP</api> <summary> <para type="synopsis">Create new TCP object.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointServiceTCP -Name MyTCP -Port 12345 </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.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.ServiceTCP.NewCheckPointServiceTCP.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.NewCheckPointServiceTCP.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP"> <api cmd="delete-service-tcp">Remove-CheckPointServiceTCP</api> <summary> <para type="synopsis">Delete existing TCP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointServiceTCP -Name MyTCP </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP.ServiceTCP"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.RemoveCheckPointServiceTCP.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP"> <api cmd="set-service-tcp">Set-CheckPointServiceTCP</api> <summary> <para type="synopsis">Edit existing TCP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointServiceTCP -Name MyTCP -MatchForAny:$false </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.ServiceTCP"> <summary> <para type="description">Group object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.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.ServiceTCP.SetCheckPointServiceTCP.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceTCP.SetCheckPointServiceTCP.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.GetCheckPointServicesUDP"> <api cmd="show-services-udp">Get-CheckPointServicesUDP</api> <summary> <para type="synopsis">Retrieve all UDP objects.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointServicesUDP </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.GetCheckPointServicesUDP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.GetCheckPointServiceUDP"> <api cmd="show-service-udp">Get-CheckPointServiceUDP</api> <summary> <para type="synopsis">Retrieve existing UDP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointServiceUDP -Name MyUDP </code> </example> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.GetCheckPointServiceUDP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP"> <api cmd="add-service-udp">New-CheckPointServiceUDP</api> <summary> <para type="synopsis">Create new UDP object.</para> <para type="description"></para> </summary> <example> <code> New-CheckPointServiceUDP -Name MyUDP -Port 12345 </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.AcceptReplies"> <summary> <para type="description">N/A</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.Groups"> <summary> <para type="description">Collection of group identifiers.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.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.ServiceUDP.NewCheckPointServiceUDP.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.NewCheckPointServiceUDP.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP"> <api cmd="delete-service-udp">Remove-CheckPointServiceUDP</api> <summary> <para type="synopsis">Delete existing UDP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Remove-CheckPointServiceUDP -Name MyUDP </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP.ServiceUDP"> <summary> <para type="description">Network object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.RemoveCheckPointServiceUDP.Remove(System.String)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP"> <api cmd="set-service-udp">Set-CheckPointServiceUDP</api> <summary> <para type="synopsis">Edit existing UDP object using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Set-CheckPointServiceUDP -Name MyUDP -MatchForAny:$false </code> </example> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.AcceptReplies"> <summary> <para type="description">N/A</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.GroupAction"> <summary> <para type="description">Action to take with groups.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.ServiceUDP"> <summary> <para type="description">Group object, name or UID.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.SessionTimeout"> <summary> <para type="description">Time (in seconds) before the session times out.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.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.ServiceUDP.SetCheckPointServiceUDP.UseDefaultSessionTimeout"> <summary> <para type="description">Use default virtual session timeout.</para> </summary> </member> <member name="P:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.InputName"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.Set(System.String)"> <inheritdoc /> </member> <member name="M:psCheckPoint.Objects.ServiceUDP.SetCheckPointServiceUDP.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Session.GetCheckPointSession"> <api cmd="show-session">Get-CheckPointSession</api> <summary> <para type="synopsis">Retrieve existing Session 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.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="M:psCheckPoint.Objects.Session.GetCheckPointSession.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.Session.GetCheckPointSessions"> <api cmd="show-sessions">Get-CheckPointSessions</api> <summary> <para type="synopsis">Retrieve all Sessions.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointSessions </code> </example> </member> <member name="P:psCheckPoint.Objects.Session.GetCheckPointSessions.ViewPublishedSessions"> <summary> <para type="description">Show a list of published sessions.</para> </summary> </member> <member name="M:psCheckPoint.Objects.Session.GetCheckPointSessions.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SimpleGateway.GetCheckPointSimpleGateway"> <api cmd="show-simple-gateway">Get-CheckPointSimpleGateway</api> <summary> <para type="synopsis">Retrieve existing Simple Gateway using object name or uid.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointSimpleGateway -Name MyGateway </code> </example> </member> <member name="M:psCheckPoint.Objects.SimpleGateway.GetCheckPointSimpleGateway.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Objects.SimpleGateway.GetCheckPointSimpleGateways"> <api cmd="show-simple-gateways">Get-CheckPointSimpleGateways</api> <summary> <para type="synopsis">Retrieve all Simple Gateways.</para> <para type="description"></para> </summary> <example> <code> Get-CheckPointSimpleGateways </code> </example> </member> <member name="M:psCheckPoint.Objects.SimpleGateway.GetCheckPointSimpleGateways.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.PSCmdletAsync"> <summary> PSCmdlet that allows for asynchronous calls </summary> <seealso cref="T:System.Management.Automation.PSCmdlet" /> </member> <member name="P:psCheckPoint.PSCmdletAsync.CancelProcessToken"> <summary> Gets the cancel process token. </summary> <value>The cancel process token.</value> </member> <member name="P:psCheckPoint.PSCmdletAsync.CancelProcess"> <summary> Gets or sets the cancellation token source used if the user cancels the call. </summary> <value>The cancellation token source.</value> </member> <member name="M:psCheckPoint.PSCmdletAsync.BeginProcessing"> <summary> Begins the processing. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.BeginProcessingAsync"> <summary> Begins the processing asynchronous. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.EndProcessing"> <summary> Ends the processing. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.EndProcessingAsync"> <summary> Ends the processing asynchronous. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.ProcessRecord"> <summary> Processes the record. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.ProcessRecordAsync"> <summary> Processes the record asynchronous. </summary> </member> <member name="M:psCheckPoint.PSCmdletAsync.StopProcessing"> <summary> Stops the processing. </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="M:psCheckPoint.Session.CloseCheckPointSession.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Session.DebugCheckPointSession"> <summary> <para type="synopsis">Debug a session.</para> <para type="description">Sets the DebugWriter to output debugs to a text file.</para> </summary> <example> <code> Debug-CheckPointSession -Path debug.txt </code> <code> Debug-CheckPointSession -Disable </code> </example> </member> <member name="P:psCheckPoint.Session.DebugCheckPointSession.Append"> <summary> <para type="description">Append to existing file.</para> </summary> </member> <member name="P:psCheckPoint.Session.DebugCheckPointSession.Disable"> <summary> <para type="description">Disables debugging and closes the current output file.</para> </summary> </member> <member name="P:psCheckPoint.Session.DebugCheckPointSession.Force"> <summary> <para type="description">Force overwritting existing file.</para> </summary> </member> <member name="P:psCheckPoint.Session.DebugCheckPointSession.Path"> <summary> <para type="description">The file name to output debug logging to.</para> </summary> </member> <member name="M:psCheckPoint.Session.DebugCheckPointSession.BeginProcessingAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.Session.GetCheckPointHash"> <summary> <para type="synopsis">Get server certicate hash that can be used to verify server's certificate.</para> <para type="description"> Used to get the certificate hash of a management server or gateway. Hash can then be used in other commands using the CertificateHash parameter on commands like Open-CheckPointSession and Add-CheckPointIdentity. </para> </summary> <example> <code> Get-CheckPointHash -Server 192.168.1.1 </code> </example> <seealso cref="T:System.Management.Automation.PSCmdlet" /> </member> <member name="P:psCheckPoint.Session.GetCheckPointHash.Port"> <summary> <para type="description">TCP Port number if not the standard HTTPS port 443</para> </summary> </member> <member name="P:psCheckPoint.Session.GetCheckPointHash.Server"> <summary> <para type="description"> IP or Hostname of the Check point Management Server or Gateway to get hash for </para> </summary> </member> <member name="M:psCheckPoint.Session.GetCheckPointHash.ProcessRecord"> <summary> Processes the record. </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.CertificateHash"> <summary> <para type="description">Server certificate hash you are expecting.</para> </summary> </member> <member name="P:psCheckPoint.Session.OpenCheckPointSession.CertificateValidation"> <summary> <para type="description">What level of certificate validation to perform.</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.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.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.HttpTimeout"> <summary> <para type="description">HTTP Request timeout in seconds. Default 100 seconds.</para> <para type="description">Use -1 for infinate</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.ManagementServer"> <summary> <para type="description">IP or Hostname of the Check point Management Server</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="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.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="M:psCheckPoint.Session.OpenCheckPointSession.ProcessRecordAsync"> <inheritdoc /> </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.PublishSession"> <summary> <para type="description">Publish none active session</para> </summary> </member> <member name="M:psCheckPoint.Session.PublishCheckPointSession.ProcessRecordAsync"> <inheritdoc /> </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.ResetSession"> <summary> <para type="description">Reset none active session</para> </summary> </member> <member name="M:psCheckPoint.Session.ResetCheckPointSession.ProcessRecordAsync"> <inheritdoc /> </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="M:psCheckPoint.Session.SendCheckPointKeepAlive.ProcessRecordAsync"> <inheritdoc /> </member> <member name="T:psCheckPoint.SetCheckPointCmdlet"> <summary> <para type="description">Base class for Set-CheckPoint*ObjectName* classes</para> </summary> </member> <member name="P:psCheckPoint.SetCheckPointCmdlet.NewName"> <summary> <para type="description">New name of the object.</para> </summary> </member> <member name="P:psCheckPoint.SetCheckPointCmdlet.TagAction"> <summary> <para type="description">Action to take with tags.</para> </summary> </member> <member name="P:psCheckPoint.SetCheckPointCmdlet.InputName"> <summary> Gets the type of object being deleted. </summary> </member> <member name="P:psCheckPoint.SetCheckPointCmdlet.Object"> <summary> <para type="description">Object to set.</para> </summary> </member> <member name="M:psCheckPoint.SetCheckPointCmdlet.ProcessRecordAsync"> <inheritdoc /> </member> <member name="M:psCheckPoint.SetCheckPointCmdlet.Set(System.String)"> <summary> Sets the specified object. </summary> <param name="value">The name or UID of the object to set.</param> </member> <member name="M:psCheckPoint.SetCheckPointCmdlet.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <inheritdoc /> </member> <member name="T:psCheckPoint.UpdateCheckPointCmdlet"> <summary> <para type="description">Base class for New and Set classes</para> </summary> </member> <member name="P:psCheckPoint.UpdateCheckPointCmdlet.Color"> <summary> <para type="description">Color of the object. Should be one of existing colors.</para> </summary> </member> <member name="P:psCheckPoint.UpdateCheckPointCmdlet.Comments"> <summary> <para type="description">Comments string.</para> </summary> </member> <member name="P:psCheckPoint.UpdateCheckPointCmdlet.Ignore"> <summary> <para type="description">Apply changes ignoring warnings or errors.</para> </summary> </member> <member name="P:psCheckPoint.UpdateCheckPointCmdlet.PassThru"> <summary> <para type="description">Return the updated object.</para> </summary> </member> <member name="P:psCheckPoint.UpdateCheckPointCmdlet.Tags"> <summary> <para type="description">Collection of tag identifiers.</para> </summary> </member> <member name="M:psCheckPoint.UpdateCheckPointCmdlet.UpdateProperties(Koopman.CheckPoint.IObjectSummary)"> <summary> Updates the properties that have been set in the command. </summary> <param name="obj">The object to set properties on.</param> </member> <member name="M:psCheckPoint.UpdateCheckPointCmdlet.UpdateProperty(Koopman.CheckPoint.IObjectSummary,System.String,System.Object)"> <summary> Updates the property on the object. </summary> <param name="obj">The object.</param> <param name="name">The name.</param> <param name="value">The value.</param> <returns> <c>true</c> if property was handled. <c>false</c> if it was not which will case the default basic set to happen. </returns> </member> <member name="M:psCheckPoint.UpdateCheckPointCmdlet.WriteObject(System.Object)"> <summary> Writes the object only if PassThru is set. </summary> <param name="result">The result.</param> </member> </members> </doc> |