psCheckPoint.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-CheckPointAccessLayer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAccessLayer</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAccessLayer</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointAccessLayer</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointAccessLayer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAccessLayer --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Access Layer</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointAccessLayer -Name Network</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointAccessLayer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointAccessLayer</command:name> <command:verb>New</command:verb> <command:noun>CheckPointAccessLayer</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointAccessLayer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AddDefaultRule --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AddDefaultRule</maml:name> <maml:description> <maml:para>Indicates whether to include a clean-up rule in the new layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: ApplicationsAndUrlFiltering --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationsAndUrlFiltering</maml:name> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentAwareness --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContentAwareness</maml:name> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DetectUsingXForwardFor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetectUsingXForwardFor</maml:name> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MobileAccess --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MobileAccess</maml:name> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Shared --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AddDefaultRule --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AddDefaultRule</maml:name> <maml:description> <maml:para>Indicates whether to include a clean-up rule in the new layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: ApplicationsAndUrlFiltering --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationsAndUrlFiltering</maml:name> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ContentAwareness --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContentAwareness</maml:name> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DetectUsingXForwardFor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetectUsingXForwardFor</maml:name> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: MobileAccess --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MobileAccess</maml:name> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Shared --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Indicates whether to include a clean-up rule in the new layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAccessLayer --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Access Layer</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointAccessLayer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointAccessLayer</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointAccessLayer</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointAccessLayer</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointAccessLayer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointAccessLayer -Name Network</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointAccessLayer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointAccessLayer</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointAccessLayer</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointAccessLayer</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApplicationsAndUrlFiltering --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationsAndUrlFiltering</maml:name> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentAwareness --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContentAwareness</maml:name> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DetectUsingXForwardFor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetectUsingXForwardFor</maml:name> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MobileAccess --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MobileAccess</maml:name> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Shared --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointAccessLayer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApplicationsAndUrlFiltering --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationsAndUrlFiltering</maml:name> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContentAwareness --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContentAwareness</maml:name> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DetectUsingXForwardFor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetectUsingXForwardFor</maml:name> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MobileAccess --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MobileAccess</maml:name> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Shared --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApplicationsAndUrlFiltering --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationsAndUrlFiltering</maml:name> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ContentAwareness --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContentAwareness</maml:name> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DetectUsingXForwardFor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetectUsingXForwardFor</maml:name> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Firewall --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Firewall</maml:name> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: MobileAccess --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MobileAccess</maml:name> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Shared --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Shared</maml:name> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Applications and URL Filtering blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Content Awareness blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Firewall blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether to enable Mobile Access blade on the layer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Whether this layer is shared.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAccessLayer --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessLayer.CheckPointAccessLayer</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Access Layer</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-CheckPointAccessLayer -Name Network -ApplicationsAndUrlFiltering $true</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointAccessLayers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAccessLayers</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAccessLayers</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointAccessLayers</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointAccessLayers --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessLayer.CheckPointAccessLayers</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointAccessLayers</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointAccessRule --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAccessRule</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAccessRule</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointAccessRule</maml:name> <!-- Parameter: Layer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Layer</maml:name> <maml:description> <maml:para>Layer that the rule belongs to identified by the name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointAccessRule</maml:name> <!-- Parameter: Layer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Layer</maml:name> <maml:description> <maml:para>Layer that the rule belongs to identified by the name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Rule Number --> <command:syntaxItem> <maml:name>Get-CheckPointAccessRule</maml:name> <!-- Parameter: Layer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Layer</maml:name> <maml:description> <maml:para>Layer that the rule belongs to identified by the name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RuleNumber --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>RuleNumber</maml:name> <maml:description> <maml:para>Rule number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RuleNumber --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>RuleNumber</maml:name> <maml:description> <maml:para>Rule number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Layer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Layer</maml:name> <maml:description> <maml:para>Layer that the rule belongs to identified by the name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Rule number.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Layer that the rule belongs to identified by the name or UID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAccessRule --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessRule.CheckPointAccessRule</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Access Rule</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-CheckPointAccessRuleBase --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAccessRuleBase</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAccessRuleBase</command:noun> <maml:description> <maml:para>Shows the entire Access Rules layer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointAccessRuleBase</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointAccessRuleBase</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAccessRule --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AccessRule.CheckPointAccessRule</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Access Rule</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-CheckPointAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAddressRange</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAddressRange</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AddressRange.CheckPointAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointAddressRange</command:name> <command:verb>New</command:verb> <command:noun>CheckPointAddressRange</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AddressRange.CheckPointAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointAddressRange</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointAddressRange</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointAddressRange</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointAddressRange</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.AddressRange.CheckPointAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointAddressRanges --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointAddressRanges</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointAddressRanges</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointAddressRanges</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointApplication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointApplication</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointApplication</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By Application ID --> <command:syntaxItem> <maml:name>Get-CheckPointApplication</maml:name> <!-- Parameter: ApplicationID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationID</maml:name> <maml:description> <maml:para>Object application identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointApplication</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointApplication</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApplicationID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationID</maml:name> <maml:description> <maml:para>Object application identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object application identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointApplication --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Application.CheckPointApplication</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Application/Site</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointApplication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointApplication</command:name> <command:verb>New</command:verb> <command:noun>CheckPointApplication</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By URLs --> <command:syntaxItem> <maml:name>New-CheckPointApplication</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlList</maml:name> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Application Signature --> <command:syntaxItem> <maml:name>New-CheckPointApplication</maml:name> <!-- Parameter: ApplicationSignature --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationSignature</maml:name> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlList</maml:name> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApplicationSignature --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationSignature</maml:name> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointApplication --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Application.CheckPointApplication</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Application/Site</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointApplication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointApplication</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointApplication</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointApplication</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointApplication</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointApplication --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointApplication</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointApplication</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By URLs --> <command:syntaxItem> <maml:name>Set-CheckPointApplication</maml:name> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategoriesAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalCategoriesAction</maml:name> <maml:description> <maml:para>Action to take with Additional Categories.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ApplicationSignatureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationSignatureAction</maml:name> <maml:description> <maml:para>Action to take with Application Signatures.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlAction</maml:name> <maml:description> <maml:para>Action to take with URLs.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UrlList --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlList</maml:name> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Application Signature --> <command:syntaxItem> <maml:name>Set-CheckPointApplication</maml:name> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategoriesAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalCategoriesAction</maml:name> <maml:description> <maml:para>Action to take with Additional Categories.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ApplicationSignature --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationSignature</maml:name> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApplicationSignatureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationSignatureAction</maml:name> <maml:description> <maml:para>Action to take with Application Signatures.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlAction</maml:name> <maml:description> <maml:para>Action to take with URLs.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointApplication</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategoriesAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalCategoriesAction</maml:name> <maml:description> <maml:para>Action to take with Additional Categories.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ApplicationSignatureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationSignatureAction</maml:name> <maml:description> <maml:para>Action to take with Application Signatures.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlAction</maml:name> <maml:description> <maml:para>Action to take with URLs.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointApplication</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategoriesAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalCategoriesAction</maml:name> <maml:description> <maml:para>Action to take with Additional Categories.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ApplicationSignatureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationSignatureAction</maml:name> <maml:description> <maml:para>Action to take with Application Signatures.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlAction</maml:name> <maml:description> <maml:para>Action to take with URLs.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryCategory --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryCategory</maml:name> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlAction</maml:name> <maml:description> <maml:para>Action to take with URLs.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UrlList --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlList</maml:name> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApplicationSignatureAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationSignatureAction</maml:name> <maml:description> <maml:para>Action to take with Application Signatures.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ApplicationSignature --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApplicationSignature</maml:name> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalCategoriesAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalCategoriesAction</maml:name> <maml:description> <maml:para>Action to take with Additional Categories.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AdditionalCategories --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AdditionalCategories</maml:name> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UrlsDefinedAsRegularExpression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UrlsDefinedAsRegularExpression</maml:name> <maml:description> <maml:para>States whether the URL is defined as a Regular Expression or not.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Each application is assigned to one primary category based on its most defining aspect.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URLs that determine this particular application.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Application signature generated by Signature Tool.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A description for the application.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointApplication --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Application.CheckPointApplication</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Application/Site</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointApplications --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointApplications</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointApplications</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointApplications</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointCommands --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointCommands</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointCommands</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointCommands</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-CheckPointFullObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointFullObject</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointFullObject</command:noun> <maml:description> <maml:para>Retrieve full object details from object summary.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Many commands return lists of object summaries.</maml:para> <maml:para>Use this to return the full objects for each summary.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointFullObject</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointObject --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Base summary details of Check Point Objects</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointGroups | Get-CheckPointFullObject</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointGroup</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointGroup</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Group.CheckPointGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$cpGroup = Get-CheckPointGroup -Name Test1</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointGroup</command:name> <command:verb>New</command:verb> <command:noun>CheckPointGroup</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Group.CheckPointGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointGroup</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointGroup</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointGroup -Name Test1 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointGroup</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointGroup</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Group.CheckPointGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$cpGroup = Set-CheckPointGroup -Name Test1 -NewName Test2 -Tags TestTag</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointGroups --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointGroups</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointGroups</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointGroups</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointGroups</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointGroupsWithExclusion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointGroupsWithExclusion</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointGroupsWithExclusion</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointGroupsWithExclusion</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointGroupWithExclusion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointGroupWithExclusion</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointGroupWithExclusion</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroupWithExclusion --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group with Exclusion</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointGroupWithExclusion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointGroupWithExclusion</command:name> <command:verb>New</command:verb> <command:noun>CheckPointGroupWithExclusion</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: Except --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Except</maml:name> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Include --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Include --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Except --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Except</maml:name> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroupWithExclusion --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group with Exclusion</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointGroupWithExclusion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointGroupWithExclusion</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointGroupWithExclusion</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointGroupWithExclusion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointGroupWithExclusion</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointGroupWithExclusion</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Except --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Except</maml:name> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Include --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointGroupWithExclusion</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Except --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Except</maml:name> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Include --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Include --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Include</maml:name> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Except --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Except</maml:name> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object to include.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object to exclude.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointGroupWithExclusion --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.GroupWithExclusion.CheckPointGroupWithExclusion</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Group with Exclusion</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointHost --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointHost</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointHost</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointHost</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointHost</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointHost --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Host.CheckPointHost</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Host</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$cpHost = Get-CheckPointHost -Name Test1</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointHost --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointHost</command:name> <command:verb>New</command:verb> <command:noun>CheckPointHost</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: IPv4 or IPv6 --> <command:syntaxItem> <maml:name>New-CheckPointHost</maml:name> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IPv4 & IPv6 --> <command:syntaxItem> <maml:name>New-CheckPointHost</maml:name> <!-- Parameter: IPv4Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IPv4 --> <command:syntaxItem> <maml:name>New-CheckPointHost</maml:name> <!-- Parameter: IPv4Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IPv6 --> <command:syntaxItem> <maml:name>New-CheckPointHost</maml:name> <!-- Parameter: IPv6Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6Address --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointHost --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Host.CheckPointHost</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Host</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-CheckPointHost -Name Test1 -ipAddress 1.2.3.4</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointHost --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointHost</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointHost</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointHost</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointHost</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointHost -Name Test1 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointHost --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointHost</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointHost</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointHost</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddress --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointHost</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddress --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddress --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6Address --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointHost --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Host.CheckPointHost</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Host</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-CheckPointHost -Name Test1 -NewName Test2 -Tags TestTag</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointHostInterface --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointHostInterface</command:name> <command:verb>New</command:verb> <command:noun>CheckPointHostInterface</command:noun> <maml:description> <maml:para>Create new host interface.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointHostInterface</maml:name> <!-- Parameter: Host --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Interface name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Host --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Interface name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointHost --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Host.CheckPointHost</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Host</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-CheckPointHostInterface --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointHostInterface</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointHostInterface</command:noun> <maml:description> <maml:para>Remove host interface.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CheckPointHostInterface</maml:name> <!-- Parameter: Host --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Interface name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Host --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Interface name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Host object (Name, UID or Host Object)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointHost --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Host.CheckPointHost</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Host</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-CheckPointHosts --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointHosts</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointHosts</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointHosts</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointHosts</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: ConvertTo-CheckPointHtml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>ConvertTo-CheckPointHtml</command:name> <command:verb>ConvertTo</command:verb> <command:noun>CheckPointHtml</command:noun> <maml:description> <maml:para>Convert output from Export-CheckPointObjects to a HTML file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pipe results from Export-CheckPointObjects to here to create a HTML report of the exported data.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ES6 --> <command:syntaxItem> <maml:name>ConvertTo-CheckPointHtml</maml:name> <!-- Parameter: Export --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export set from Export-CheckPointObjects</maml:para> </maml:description> <command:parameterValue required="true">CheckPointExportSet</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Extra.Export.CheckPointExportSet</maml:name> <maml:uri /> <maml:description> <maml:para>Contains arrays of all exported objects including rules, groups, hosts, etc</maml:para> <maml:para>Any unknown exported object will have summary in "Other" array</maml:para> <maml:para>Pipe this to other commands like ConvertTo-CheckPointHtml or ConvertToJson for final export results</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IndentedJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndentedJson</maml:name> <maml:description> <maml:para>Indent the JSON data in the HTML output.</maml:para> <maml:para>This will force the use of "Template Literals" which requires an ES6 compatible browser. (`{JSON}`)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open file afterwards in default browser.</maml:para> <maml:para>If no filename provides then temp file will be created.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Out --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write HTML file to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Filename to HTML file to use as template.</maml:para> <maml:para>{JSON} will be replaced with JSON data.</maml:para> <maml:para>Leave blank to use default template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ES5 --> <command:syntaxItem> <maml:name>ConvertTo-CheckPointHtml</maml:name> <!-- Parameter: Export --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export set from Export-CheckPointObjects</maml:para> </maml:description> <command:parameterValue required="true">CheckPointExportSet</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Extra.Export.CheckPointExportSet</maml:name> <maml:uri /> <maml:description> <maml:para>Contains arrays of all exported objects including rules, groups, hosts, etc</maml:para> <maml:para>Any unknown exported object will have summary in "Other" array</maml:para> <maml:para>Pipe this to other commands like ConvertTo-CheckPointHtml or ConvertToJson for final export results</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: EscapeJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EscapeJson</maml:name> <maml:description> <maml:para>Escape JSON text before inserting into HTML file.</maml:para> <maml:para>Automatically turned on if template uses double quotes to define location for JSON. ("{JSON}")</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open file afterwards in default browser.</maml:para> <maml:para>If no filename provides then temp file will be created.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Out --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write HTML file to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Filename to HTML file to use as template.</maml:para> <maml:para>{JSON} will be replaced with JSON data.</maml:para> <maml:para>Leave blank to use default template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Export --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export set from Export-CheckPointObjects</maml:para> </maml:description> <command:parameterValue required="true">CheckPointExportSet</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Extra.Export.CheckPointExportSet</maml:name> <maml:uri /> <maml:description> <maml:para>Contains arrays of all exported objects including rules, groups, hosts, etc</maml:para> <maml:para>Any unknown exported object will have summary in "Other" array</maml:para> <maml:para>Pipe this to other commands like ConvertTo-CheckPointHtml or ConvertToJson for final export results</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Out --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Out</maml:name> <maml:description> <maml:para>Filename to write HTML file to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open file afterwards in default browser.</maml:para> <maml:para>If no filename provides then temp file will be created.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Filename to HTML file to use as template.</maml:para> <maml:para>{JSON} will be replaced with JSON data.</maml:para> <maml:para>Leave blank to use default template.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IndentedJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndentedJson</maml:name> <maml:description> <maml:para>Indent the JSON data in the HTML output.</maml:para> <maml:para>This will force the use of "Template Literals" which requires an ES6 compatible browser. (`{JSON}`)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EscapeJson --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EscapeJson</maml:name> <maml:description> <maml:para>Escape JSON text before inserting into HTML file.</maml:para> <maml:para>Automatically turned on if template uses double quotes to define location for JSON. ("{JSON}")</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>psCheckPoint.Extra.Export.CheckPointExportSet</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Export set from Export-CheckPointObjects</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-CheckPointObjects -Verbose $InputObject | ConvertTo-CheckPointHtml -Open</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-CheckPointIdentity --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CheckPointIdentity</command:name> <command:verb>Add</command:verb> <command:noun>CheckPointIdentity</command:noun> <maml:description> <maml:para>Creates a new Identity Awareness association for a specified IP address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-CheckPointIdentity</maml:name> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Association IP. Supports either IPv4 or IPv6, but not both.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HostType</maml:name> <maml:description> <maml:para>Type of host device. For example: Apple iOS device.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Machine --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machine</maml:name> <maml:description> <maml:para>Computer name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineGroups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MachineGroups</maml:name> <maml:description> <maml:para>List of groups to which the computer belongs(when Identity Awareness does not fetch computer groups).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineOS --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MachineOS</maml:name> <maml:description> <maml:para>Host operating system. For example: Windows 7.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoCalculateRoles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCalculateRoles</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness calculates the identity’s access roles.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoFetchMachineGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoFetchMachineGroups</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness fetches the machine's groups from the user directories defined in SmartConsole.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoFetchUserGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoFetchUserGroups</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness fetches the user's groups from the user directories defined in SmartConsole.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>List of roles to assign to this identity (when Identity Awareness does not calculate roles).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Timeout (in seconds) for this Identity Awareness association.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>43200</dev:defaultValue> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserGroups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserGroups</maml:name> <maml:description> <maml:para>List of groups to which the user belongs (when Identity Awareness does not fetch user groups).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Association IP. Supports either IPv4 or IPv6, but not both.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: User --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>User name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Machine --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machine</maml:name> <maml:description> <maml:para>Computer name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Timeout (in seconds) for this Identity Awareness association.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>43200</dev:defaultValue> </command:parameter> <!-- Parameter: NoFetchUserGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoFetchUserGroups</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness fetches the user's groups from the user directories defined in SmartConsole.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoFetchMachineGroups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoFetchMachineGroups</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness fetches the machine's groups from the user directories defined in SmartConsole.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UserGroups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserGroups</maml:name> <maml:description> <maml:para>List of groups to which the user belongs (when Identity Awareness does not fetch user groups).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineGroups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MachineGroups</maml:name> <maml:description> <maml:para>List of groups to which the computer belongs(when Identity Awareness does not fetch computer groups).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoCalculateRoles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCalculateRoles</maml:name> <maml:description> <maml:para>Defines whether Identity Awareness calculates the identity’s access roles.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>List of roles to assign to this identity (when Identity Awareness does not calculate roles).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineOS --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MachineOS</maml:name> <maml:description> <maml:para>Host operating system. For example: Windows 7.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HostType</maml:name> <maml:description> <maml:para>Type of host device. For example: Apple iOS device.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Association IP. Supports either IPv4 or IPv6, but not both.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Computer name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Domain name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Timeout (in seconds) for this Identity Awareness association.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of groups to which the user belongs (when Identity Awareness does not fetch user groups).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of groups to which the computer belongs(when Identity Awareness does not fetch computer groups).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of roles to assign to this identity (when Identity Awareness does not calculate roles).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Host operating system. For example: Windows 7.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Type of host device. For example: Apple iOS device.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: AddIdentityResponse --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.IA.AddIdentityResponse</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev: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"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointIdentity --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointIdentity</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointIdentity</command:noun> <maml:description> <maml:para>Queries the Identity Awareness associations of a given IP.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointIdentity</maml:name> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Identity IP</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Identity IP</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Identity IP</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: GetIdentityResponse --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.IA.GetIdentityResponse</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointIdentity -Gateway 192.168.1.1 -SharedSecret *** -NoCertificateValidation -IPAddress 192.168.1.2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointIdentity --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointIdentity</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointIdentity</command:noun> <maml:description> <maml:para>Queries the Identity Awareness associations of a given IP.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: ip --> <command:syntaxItem> <maml:name>Remove-CheckPointIdentity</maml:name> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Association IP. Required when you revoke a single IP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: ClientType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>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)</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: mask --> <command:syntaxItem> <maml:name>Remove-CheckPointIdentity</maml:name> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>Subnet. Required when the revoke method is mask.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>Subnet mask. Required when the revoke method is mask.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: ClientType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>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)</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: range --> <command:syntaxItem> <maml:name>Remove-CheckPointIdentity</maml:name> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>First IP in the range.Required when the revoke method is range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>Last IP in the range. Required when the revoke method is range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: ClientType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>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)</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Association IP. Required when you revoke a single IP.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>Subnet. Required when the revoke method is mask.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>Subnet mask. Required when the revoke method is mask.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>First IP in the range.Required when the revoke method is range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>Last IP in the range. Required when the revoke method is range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClientType --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientType</maml:name> <maml:description> <maml:para>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)</maml:para> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Gateway --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>IP or Hostname of the gateway server.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharedSecret --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharedSecret</maml:name> <maml:description> <maml:para>Shared secret.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BatchSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BatchSize</maml:name> <maml:description> <maml:para>When using pipeline to send multiple requests at once, how many to batch together and send as single request.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Association IP. Required when you revoke a single IP.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Subnet. Required when the revoke method is mask.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Subnet mask. Required when the revoke method is mask.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IP in the range.Required when the revoke method is range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IP in the range. Required when the revoke method is range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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)</maml:para> <maml:para>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.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: RemoveIdentityResponse --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.IA.RemoveIdentityResponse</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointIdentity -Gateway 192.168.1.1 -SharedSecret *** -NoCertificateValidation -IPAddress 192.168.1.2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-CheckPointKeepAlive --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-CheckPointKeepAlive</command:name> <command:verb>Send</command:verb> <command:noun>CheckPointKeepAlive</command:noun> <maml:description> <maml:para>Keep the session valid/alive.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-CheckPointKeepAlive</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Send-CheckPointKeepAlive</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointMulticastAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointMulticastAddressRange</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointMulticastAddressRange</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointMulticastAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Multicast Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointMulticastAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointMulticastAddressRange</command:name> <command:verb>New</command:verb> <command:noun>CheckPointMulticastAddressRange</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPAddress"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv4Address"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv6Address"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPAddress"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPAddress"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>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.</maml:para> <maml:para>This is an alias of the IPAddressFirst parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv4Address"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv4Address"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> <maml:para>This is an alias of the IPv4AddressFirst parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv6Address"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="IPv6Address"> <maml:name>IPv6Address</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> <maml:para>This is an alias of the IPv6AddressFirst parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointMulticastAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Multicast Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointMulticastAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointMulticastAddressRange</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointMulticastAddressRange</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointMulticastAddressRange --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointMulticastAddressRange</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointMulticastAddressRange</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointMulticastAddressRange</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IPAddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressFirst</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPAddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPAddressLast</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressFirst</maml:name> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv4AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv4AddressLast</maml:name> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressFirst --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressFirst</maml:name> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPv6AddressLast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IPv6AddressLast</maml:name> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv4 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>First IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Last IPv6 address in the range.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointMulticastAddressRange --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.MulticastAddressRange.CheckPointMulticastAddressRange</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Multicast Address Range</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointMulticastAddressRanges --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointMulticastAddressRanges</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointMulticastAddressRanges</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointMulticastAddressRanges</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointNetwork</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointNetwork</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointNetwork</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointNetwork</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointNetwork --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Network.CheckPointNetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Network</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointNetwork -Name Test1</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointNetwork</command:name> <command:verb>New</command:verb> <command:noun>CheckPointNetwork</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointNetwork</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Broadcast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Subnet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Subnet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskLength --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Broadcast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointNetwork --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Network.CheckPointNetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Network</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-CheckPointNetwork -Name Test1 ...</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointNetwork</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointNetwork</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointNetwork</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointNetwork</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointNetwork -Name Test1 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointNetwork --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointNetwork</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointNetwork</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointNetwork</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Broadcast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Subnet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointNetwork</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Broadcast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Subnet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Subnet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet4</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subnet6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subnet6</maml:name> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskLength --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength4 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength4</maml:name> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MaskLength6 --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaskLength6</maml:name> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SubnetMask --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Broadcast --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Broadcast</maml:name> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network mask length.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv6 network mask length.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IPv4 network address.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Allow broadcast address inclusion.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointNetwork --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Network.CheckPointNetwork</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Network</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-CheckPointNetwork -Name Test1 -NewName Test2 -Tags TestTag</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointNetworks --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointNetworks</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointNetworks</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointNetworks</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointNetworks</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-CheckPointObjects --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-CheckPointObjects</command:name> <command:verb>Export</command:verb> <command:noun>CheckPointObjects</command:noun> <maml:description> <maml:para>Export input objects and any other object used by input objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Performs an export of input objects and any object used by an input object.</maml:para> <maml:para>Input objects could be of the following types:</maml:para> <maml:para>* Any Check Point Object like Host, Network, Rule, etc</maml:para> <maml:para>* Output from Get-CheckPointWhereUsed</maml:para> <maml:para>* Output from Get-CheckPointObjects</maml:para> <maml:para>* An array or list of objects of any mixture of above</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-CheckPointObjects</maml:name> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Max depth to look for objects used by input objects</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeByName</maml:name> <maml:description> <maml:para>Enter names of objects to exclude from export</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeByType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeByType</maml:name> <maml:description> <maml:para>Enter types of objects to exclude from export</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDetailsByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDetailsByName</maml:name> <maml:description> <maml:para>Enter names of objects you do not want export to search for children of</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDetailsByType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDetailsByType</maml:name> <maml:description> <maml:para>Enter types of objects you do not want export to search for children of</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IndirectWhereUsed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectWhereUsed</maml:name> <maml:description> <maml:para>When passing Check Point objects as input perform a indirect where used instead of the standard direct only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SkipWhereUsed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipWhereUsed</maml:name> <maml:description> <maml:para>Even if input object is not a rule do not perform a where used</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Session --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Max depth to look for objects used by input objects</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeByName</maml:name> <maml:description> <maml:para>Enter names of objects to exclude from export</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeByType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeByType</maml:name> <maml:description> <maml:para>Enter types of objects to exclude from export</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDetailsByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDetailsByName</maml:name> <maml:description> <maml:para>Enter names of objects you do not want export to search for children of</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeDetailsByType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDetailsByType</maml:name> <maml:description> <maml:para>Enter types of objects you do not want export to search for children of</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipWhereUsed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipWhereUsed</maml:name> <maml:description> <maml:para>Even if input object is not a rule do not perform a where used</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IndirectWhereUsed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectWhereUsed</maml:name> <maml:description> <maml:para>When passing Check Point objects as input perform a indirect where used instead of the standard direct only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input objects to start export from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointExportSet --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Extra.Export.CheckPointExportSet</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Contains arrays of all exported objects including rules, groups, hosts, etc</maml:para> <maml:para>Any unknown exported object will have summary in "Other" array</maml:para> <maml:para>Pipe this to other commands like ConvertTo-CheckPointHtml or ConvertToJson for final export results</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-CheckPointObjects -Verbose $InputObject1 $InputObject2 ... $InputObjectX | ConvertTo-CheckPointHtml -Open</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointObjects --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointObjects</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointObjects</command:noun> <maml:description> <maml:para>Find objects by Filter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Can find many different types of objects based on a filter. Filters are same as what can be used in Smart Console</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointObjects</maml:name> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOnly</maml:name> <maml:description> <maml:para>If using "filter", use this field to search objects by their IP address only, without involving the textual search.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The objects' type</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>object</dev:defaultValue> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IPOnly</maml:name> <maml:description> <maml:para>If using "filter", use this field to search objects by their IP address only, without involving the textual search.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The objects' type</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>object</dev:defaultValue> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointObjects -Filter "O365 OR Office365"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Install-CheckPointPolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Install-CheckPointPolicy</command:name> <command:verb>Install</command:verb> <command:noun>CheckPointPolicy</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Install-CheckPointPolicy</maml:name> <!-- Parameter: PolicyPackage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyPackage</maml:name> <maml:description> <maml:para>The name of the Policy Package to be installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Access --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Access</maml:name> <maml:description> <maml:para>Set to be true in order to install the access policy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableInstallOnAllClusterMembersOrFail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableInstallOnAllClusterMembersOrFail</maml:name> <maml:description> <maml:para>install-on-all-cluster-members-or-fail</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrepareOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrepareOnly</maml:name> <maml:description> <maml:para>If true, prepares the policy for the installation, but doesn't install it on an installation target.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Revision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Revision</maml:name> <maml:description> <maml:para>The UID of the revision of the policy to install.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Targets --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ThreatPrevention --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ThreatPrevention</maml:name> <maml:description> <maml:para>Set to be true in order to install the threat prevention policy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PolicyPackage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyPackage</maml:name> <maml:description> <maml:para>The name of the Policy Package to be installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Access --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Access</maml:name> <maml:description> <maml:para>Set to be true in order to install the access policy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DisableInstallOnAllClusterMembersOrFail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableInstallOnAllClusterMembersOrFail</maml:name> <maml:description> <maml:para>install-on-all-cluster-members-or-fail</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PrepareOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrepareOnly</maml:name> <maml:description> <maml:para>If true, prepares the policy for the installation, but doesn't install it on an installation target.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Revision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Revision</maml:name> <maml:description> <maml:para>The UID of the revision of the policy to install.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Targets --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ThreatPrevention --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ThreatPrevention</maml:name> <maml:description> <maml:para>Set to be true in order to install the threat prevention policy.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Test-CheckPointPolicy --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-CheckPointPolicy</command:name> <command:verb>Test</command:verb> <command:noun>CheckPointPolicy</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-CheckPointPolicy</maml:name> <!-- Parameter: PolicyPackage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyPackage</maml:name> <maml:description> <maml:para>The name of the Policy Package to be installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PolicyPackage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PolicyPackage</maml:name> <maml:description> <maml:para>The name of the Policy Package to be installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Invoke-CheckPointScript --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-CheckPointScript</command:name> <command:verb>Invoke</command:verb> <command:noun>CheckPointScript</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By Inline Script --> <command:syntaxItem> <maml:name>Invoke-CheckPointScript</maml:name> <!-- Parameter: Script --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script Body</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptName</maml:name> <maml:description> <maml:para>Script Name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Targets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Args --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Args</maml:name> <maml:description> <maml:para>Script arguments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Script File --> <command:syntaxItem> <maml:name>Invoke-CheckPointScript</maml:name> <!-- Parameter: ScriptFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptFile</maml:name> <maml:description> <maml:para>Load Script Body from File</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptName</maml:name> <maml:description> <maml:para>Script Name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Targets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Args --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Args</maml:name> <maml:description> <maml:para>Script arguments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ScriptName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptName</maml:name> <maml:description> <maml:para>Script Name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Script --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>Script Body</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ScriptFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScriptFile</maml:name> <maml:description> <maml:para>Load Script Body from File</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Args --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Args</maml:name> <maml:description> <maml:para>Script arguments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Targets --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Targets</maml:name> <maml:description> <maml:para>On what targets to execute this command. Targets may be identified by their name, or object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Script Body</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-CheckPointSecurityZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointSecurityZone</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointSecurityZone</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointSecurityZone</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointSecurityZone</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointSecurityZone --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.SecurityZone.CheckPointSecurityZone</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Security Zone</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointSecurityZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointSecurityZone</command:name> <command:verb>New</command:verb> <command:noun>CheckPointSecurityZone</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointSecurityZone</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointSecurityZone --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.SecurityZone.CheckPointSecurityZone</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Security Zone</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointSecurityZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointSecurityZone</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointSecurityZone</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointSecurityZone</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointSecurityZone</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointSecurityZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointSecurityZone</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointSecurityZone</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointSecurityZone</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointSecurityZone</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointSecurityZone --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.SecurityZone.CheckPointSecurityZone</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Security Zone</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointSecurityZones --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointSecurityZones</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointSecurityZones</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointSecurityZones</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServiceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServiceGroup</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServiceGroup</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointServiceGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointServiceGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Service Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointGroup -Name Test1</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointServiceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointServiceGroup</command:name> <command:verb>New</command:verb> <command:noun>CheckPointServiceGroup</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointServiceGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Service Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointServiceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointServiceGroup</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointServiceGroup</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-CheckPointGroup -Name Test1 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointServiceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointServiceGroup</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointServiceGroup</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointServiceGroup</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointServiceGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MemberAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemberAction</maml:name> <maml:description> <maml:para>Action to take with members.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Members --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of Network objects identified by the name or UID.</maml:para> <maml:para>Members listed will be either Added, Removed or replace the current list of members based on MemberAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceGroup --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceGroup.CheckPointServiceGroup</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Service Group</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-CheckPointGroup -Name Test1 -NewName Test2 -Tags TestTag</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServiceGroups --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServiceGroups</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServiceGroups</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointServiceGroups</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointObjects --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObjects</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServicesTCP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServicesTCP</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServicesTCP</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointServicesTCP</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointServices --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Service.CheckPointServices</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServicesUDP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServicesUDP</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServicesUDP</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointServicesUDP</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointServices --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Service.CheckPointServices</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServiceTCP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServiceTCP</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServiceTCP</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointServiceTCP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointServiceTCP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceTCP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point TCP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointServiceTCP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointServiceTCP</command:name> <command:verb>New</command:verb> <command:noun>CheckPointServiceTCP</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointServiceTCP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceTCP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point TCP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointServiceTCP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointServiceTCP</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointServiceTCP</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceTCP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceTCP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointServiceTCP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointServiceTCP</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointServiceTCP</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointServiceTCP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointServiceTCP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceTCP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceTCP.CheckPointServiceTCP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point TCP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointServiceUDP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointServiceUDP</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointServiceUDP</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointServiceUDP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointServiceUDP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceUDP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point UDP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-CheckPointServiceUDP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-CheckPointServiceUDP</command:name> <command:verb>New</command:verb> <command:noun>CheckPointServiceUDP</command:noun> <maml:description> <maml:para>Create new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-CheckPointServiceUDP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AcceptReplies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptReplies</maml:name> <maml:description> <maml:para>N/A</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AcceptReplies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptReplies</maml:name> <maml:description> <maml:para>N/A</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetIfExists</maml:name> <maml:description> <maml:para>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!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name. Should be unique in the domain.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceUDP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point UDP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-CheckPointServiceUDP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CheckPointServiceUDP</command:name> <command:verb>Remove</command:verb> <command:noun>CheckPointServiceUDP</command:noun> <maml:description> <maml:para>Delete existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceUDP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Remove-CheckPointServiceUDP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-CheckPointServiceUDP --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-CheckPointServiceUDP</command:name> <command:verb>Set</command:verb> <command:noun>CheckPointServiceUDP</command:noun> <maml:description> <maml:para>Edit existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Set-CheckPointServiceUDP</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AcceptReplies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptReplies</maml:name> <maml:description> <maml:para>N/A</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Set-CheckPointServiceUDP</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AcceptReplies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptReplies</maml:name> <maml:description> <maml:para>N/A</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AcceptReplies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AcceptReplies</maml:name> <maml:description> <maml:para>N/A</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: KeepConnectionsOpenAfterPolicyInstallation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepConnectionsOpenAfterPolicyInstallation</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchByProtocolSignature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchByProtocolSignature</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: MatchForAny --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchForAny</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OverrideDefaultSettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideDefaultSettings</maml:name> <maml:description> <maml:para>Indicates whether this service is a Data Domain service which has been overridden.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Protocol --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>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).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Time (in seconds) before the session times out.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourcePort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourcePort</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncConnectionsOnCluster --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncConnectionsOnCluster</maml:name> <maml:description> <maml:para>Enables state-synchronised High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UseDefaultSessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseDefaultSessionTimeout</maml:name> <maml:description> <maml:para>Use default virtual session timeout.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: GroupAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupAction</maml:name> <maml:description> <maml:para>Action to take with groups.</maml:para> <maml:para>Possible values: Replace, Add, Remove</maml:para> </maml:description> <command:parameterValue required="true">MembershipActions</command:parameterValue> <dev:type> <maml:name>psCheckPoint.MembershipActions</maml:name> <maml:uri /> <maml:description> <maml:para>Action to take when changing membership of object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Replace</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> <command:parameterValue required="false" variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Comments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Comments</maml:name> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreWarnings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreWarnings</maml:name> <maml:description> <maml:para>Apply changes ignoring warnings.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreErrors</maml:name> <maml:description> <maml:para>Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the updated object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Color</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Colour"> <maml:name>Colour</maml:name> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> <maml:para>This is an alias of the Color parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of group identifiers.</maml:para> <maml:para>Groups listed will be either Added, Removed or replace the current list of group membership based on GroupAction parameter.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>New name of the object.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Collection of tag identifiers.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Comments string.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color of the object. Should be one of existing colors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointServiceUDP --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.ServiceUDP.CheckPointServiceUDP</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point UDP Service</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Close-CheckPointSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Close-CheckPointSession</command:name> <command:verb>Close</command:verb> <command:noun>CheckPointSession</command:noun> <maml:description> <maml:para>Log out of a session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Close-CheckPointSession</maml:name> <!-- Parameter: ContinueSessionInSmartconsole --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueSessionInSmartconsole</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ContinueSessionInSmartconsole --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueSessionInSmartconsole</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Close-CheckPointSession</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointSession</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointSession</command:noun> <maml:description> <maml:para>Retrieve existing object using object name or uid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointSession</maml:name> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Session unique identifier. If not provided the current logged in session UID will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Session unique identifier. If not provided the current logged in session UID will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Session unique identifier. If not provided the current logged in session UID will be used.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointSession --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Details of a Check Point Session</maml:para> <maml:para>This session object does NOT include login details so cannot be used as Session parameter in other commands</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointSession</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Open-CheckPointSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Open-CheckPointSession</command:name> <command:verb>Open</command:verb> <command:noun>CheckPointSession</command:noun> <maml:description> <maml:para>Log in to the server with user name and password.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Open-CheckPointSession</maml:name> <!-- Parameter: ManagementServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ManagementServer</maml:name> <maml:description> <maml:para>IP or Hostname of the Check point Management Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>PSCredential containing User name and Password. If not provided you will be prompted.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ContinueLastSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueLastSession</maml:name> <maml:description> <maml:para>The new session would continue where the last session was stopped.</maml:para> <maml:para>This option is available when the administrator has only one session that can be continued.</maml:para> <maml:para>If there is more than one session, see 'switch-session' API.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Use domain to login to specific domain. Domain can be identified by name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnterLastPublishedSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnterLastPublishedSession</maml:name> <maml:description> <maml:para>Login to the last published session. Such login is done with the Read Only permissions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ManagementPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagementPort</maml:name> <maml:description> <maml:para>Port Web API running on. Default: 443</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCompression</maml:name> <maml:description> <maml:para>Do not enable HTTP compression.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the session and do not store it for automatic use.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Login with Read Only permissions. This parameter is not considered in case continue-last-session is true.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SessionComments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionComments</maml:name> <maml:description> <maml:para>Session comments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionDescription</maml:name> <maml:description> <maml:para>Session description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionName</maml:name> <maml:description> <maml:para>Session unique name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Session expiration timeout in seconds. Default 600 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ManagementServer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ManagementServer</maml:name> <maml:description> <maml:para>IP or Hostname of the Check point Management Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ManagementPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManagementPort</maml:name> <maml:description> <maml:para>Port Web API running on. Default: 443</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>443</dev:defaultValue> </command:parameter> <!-- Parameter: Credentials --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Credentials</maml:name> <maml:description> <maml:para>PSCredential containing User name and Password. If not provided you will be prompted.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Login with Read Only permissions. This parameter is not considered in case continue-last-session is true.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ContinueLastSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContinueLastSession</maml:name> <maml:description> <maml:para>The new session would continue where the last session was stopped.</maml:para> <maml:para>This option is available when the administrator has only one session that can be continued.</maml:para> <maml:para>If there is more than one session, see 'switch-session' API.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Use domain to login to specific domain. Domain can be identified by name or UID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnterLastPublishedSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnterLastPublishedSession</maml:name> <maml:description> <maml:para>Login to the last published session. Such login is done with the Read Only permissions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SessionComments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionComments</maml:name> <maml:description> <maml:para>Session comments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionDescription</maml:name> <maml:description> <maml:para>Session description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionName</maml:name> <maml:description> <maml:para>Session unique name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionTimeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionTimeout</maml:name> <maml:description> <maml:para>Session expiration timeout in seconds. Default 600 seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NoCertificateValidation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCertificateValidation</maml:name> <maml:description> <maml:para>Do NOT verify server's certificate.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NoCompression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoCompression</maml:name> <maml:description> <maml:para>Do not enable HTTP compression.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Return the session and do not store it for automatic use.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointSession --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Open-CheckPointSession -ManagementServer 192.168.1.1</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$Session = Open-CheckPointSession -ManagementServer 192.168.1.1 -PassThru</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Publish-CheckPointSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Publish-CheckPointSession</command:name> <command:verb>Publish</command:verb> <command:noun>CheckPointSession</command:noun> <maml:description> <maml:para>All the changes done by this user will be seen by all users only after publish is called.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Publish-CheckPointSession</maml:name> <!-- Parameter: PublishSession --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>PublishSession</maml:name> <maml:description> <maml:para>Publish none active session</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Details of a Check Point Session</maml:para> <maml:para>This session object does NOT include login details so cannot be used as Session parameter in other commands</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PublishSession --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>PublishSession</maml:name> <maml:description> <maml:para>Publish none active session</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Details of a Check Point Session</maml:para> <maml:para>This session object does NOT include login details so cannot be used as Session parameter in other commands</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Publish none active session</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Publish-CheckPointSession</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Reset-CheckPointSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-CheckPointSession</command:name> <command:verb>Reset</command:verb> <command:noun>CheckPointSession</command:noun> <maml:description> <maml:para>Log out of a session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Reset-CheckPointSession</maml:name> <!-- Parameter: ResetSession --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ResetSession</maml:name> <maml:description> <maml:para>Reset none active session</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Details of a Check Point Session</maml:para> <maml:para>This session object does NOT include login details so cannot be used as Session parameter in other commands</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ResetSession --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ResetSession</maml:name> <maml:description> <maml:para>Reset none active session</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Details of a Check Point Session</maml:para> <maml:para>This session object does NOT include login details so cannot be used as Session parameter in other commands</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Reset none active session</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Reset-CheckPointSession</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointSessions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointSessions</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointSessions</command:noun> <maml:description> <maml:para>Retrieve all objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointSessions</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: ViewPublishedSessions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewPublishedSessions</maml:name> <maml:description> <maml:para>Show a list of published sessions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ViewPublishedSessions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ViewPublishedSessions</maml:name> <maml:description> <maml:para>Show a list of published sessions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>No more than that many results will be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Skip that many results before beginning to return them.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: CheckPointSessions --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Session.CheckPointSessions</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Result from commands that return multiple objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointTask</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointTask</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CheckPointTask</maml:name> <!-- Parameter: TaskID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TaskID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Wait-CheckPointTask --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Wait-CheckPointTask</command:name> <command:verb>Wait</command:verb> <command:noun>CheckPointTask</command:noun> <maml:description> <maml:para>Waits for task to complete.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Waits for task to complete then returns the completed task details.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Wait-CheckPointTask</maml:name> <!-- Parameter: TaskID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SleepTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SleepTime</maml:name> <maml:description> <maml:para>Time in seconds to sleep in-between checking task status</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout in seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SleepTime --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SleepTime</maml:name> <maml:description> <maml:para>Time in seconds to sleep in-between checking task status</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout in seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>300</dev:defaultValue> </command:parameter> <!-- Parameter: TaskID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>TaskID</maml:name> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Unique identifier of task</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Install-CheckPointPolicy -PolicyPackage Standard -Targets MyGateway | Wait-CheckPointTask -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-CheckPointWhereUsed --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CheckPointWhereUsed</command:name> <command:verb>Get</command:verb> <command:noun>CheckPointWhereUsed</command:noun> <maml:description> <maml:para>Searches for usage of the target object in other objects and rules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: By UID --> <command:syntaxItem> <maml:name>Get-CheckPointWhereUsed</maml:name> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ByUID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ByUID</maml:name> <maml:description> <maml:para>Force by UID. Used if pipelining in list of UIDs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Indirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Indirect</maml:name> <maml:description> <maml:para>Search for indirect usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IndirectMaxDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectMaxDepth</maml:name> <maml:description> <maml:para>Maximum nesting level during indirect usage search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Name --> <command:syntaxItem> <maml:name>Get-CheckPointWhereUsed</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ByName</maml:name> <maml:description> <maml:para>Force by name. Used if pipelining in list of names.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Indirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Indirect</maml:name> <maml:description> <maml:para>Search for indirect usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IndirectMaxDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectMaxDepth</maml:name> <maml:description> <maml:para>Maximum nesting level during indirect usage search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: By Object --> <command:syntaxItem> <maml:name>Get-CheckPointWhereUsed</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Check Point Object.</maml:para> </maml:description> <command:parameterValue required="true">CheckPointObject</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObject</maml:name> <maml:uri /> <maml:description> <maml:para>Base summary details of Check Point Objects</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Indirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Indirect</maml:name> <maml:description> <maml:para>Search for indirect usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IndirectMaxDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectMaxDepth</maml:name> <maml:description> <maml:para>Maximum nesting level during indirect usage search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UID</maml:name> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ByUID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ByUID</maml:name> <maml:description> <maml:para>Force by UID. Used if pipelining in list of UIDs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Object name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ByName</maml:name> <maml:description> <maml:para>Force by name. Used if pipelining in list of names.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Check Point Object.</maml:para> </maml:description> <command:parameterValue required="true">CheckPointObject</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObject</maml:name> <maml:uri /> <maml:description> <maml:para>Base summary details of Check Point Objects</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Indirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Indirect</maml:name> <maml:description> <maml:para>Search for indirect usage.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IndirectMaxDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IndirectMaxDepth</maml:name> <maml:description> <maml:para>Maximum nesting level during indirect usage search.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <!-- Parameter: Session --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Session</maml:name> <maml:description> <maml:para>Session object from Open-CheckPointSession</maml:para> </maml:description> <command:parameterValue required="true">CheckPointSession</command:parameterValue> <dev:type> <maml:name>psCheckPoint.Session.CheckPointSession</maml:name> <maml:uri /> <maml:description> <maml:para>Used across other Check Point Web API Calls</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object unique identifier.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>psCheckPoint.Objects.CheckPointObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Check Point Object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CheckPointWhereUsed --> <command:returnValue> <dev:type> <maml:name>psCheckPoint.Objects.Misc.CheckPointWhereUsed</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Summary of Where Used results</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CheckPointWhereUsed -Name http</dev:code> </command:example> </command:examples> </command:command> </helpItems> |