en-US/PSCloudFlare-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-CFFirewallRule</command:name> <command:verb>Add</command:verb> <command:noun>CFFirewallRule</command:noun> <maml:description><maml:para>Adds a cloudflare firewall rule. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Adds a cloudflare firewall rule. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-CFFirewallRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Target</maml:name> <maml:Description><maml:para>Are you adding an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Ip</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>What is this rule going to do? Options include whitelist, block, challenge, js_challenge. Default is to whitelist. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Whitelist</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Notes</maml:name> <maml:Description><maml:para>Any additional notes for the added firewall rule </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Target</maml:name> <maml:Description><maml:para>Are you adding an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Ip</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>What is this rule going to do? Options include whitelist, block, challenge, js_challenge. Default is to whitelist. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Whitelist</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Notes</maml:name> <maml:Description><maml:para>Any additional notes for the added firewall rule </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Add-CFFirewallRule -ZoneID $ZoneID -Item '96.9.128.0/24' -Notes 'Load Balancer Ip Block - 4.1' -Target 'ip_range' -Mode:challenge -Verbose</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Connect-CFClientAPI</command:name> <command:verb>Connect</command:verb> <command:noun>CFClientAPI</command:noun> <maml:description><maml:para>Connects to the CloudFlare API for future requests. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Connects to the CloudFlare API for future requests. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Connect-CFClientAPI</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>APIToken</maml:name> <maml:Description><maml:para>The Cloudflare API token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>EmailAddress</maml:name> <maml:Description><maml:para>The associated email address with this Cloudflare API token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>APIToken</maml:name> <maml:Description><maml:para>The Cloudflare API token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>EmailAddress</maml:name> <maml:Description><maml:para>The associated email address with this Cloudflare API token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Connect-CFClientAPI -APIToken xxxxxxxxxxxxxxxxxxxxx -EmailAddress 'jdoe@contoso.com'</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFCurrentZone</command:name> <command:verb>Get</command:verb> <command:noun>CFCurrentZone</command:noun> <maml:description><maml:para>Gets the currently targeted ZoneID. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Gets the currently targeted ZoneID. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFCurrentZone</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFRequestData</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFCurrentZoneID</command:name> <command:verb>Get</command:verb> <command:noun>CFCurrentZoneID</command:noun> <maml:description><maml:para>Gets the currently targeted ZoneID. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Gets the currently targeted ZoneID. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFCurrentZoneID</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFRequestData</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFFirewallRule</command:name> <command:verb>Get</command:verb> <command:noun>CFFirewallRule</command:noun> <maml:description><maml:para>List Cloudflare firewall rules. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare firewall rules. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFFirewallRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>MatchItem</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code if matching by Target in your search. Default is null (match all items). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>MatchTarget</maml:name> <maml:Description><maml:para>Are you matching an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">ip</command:parameterValue> <command:parameterValue required="false" variableLength="false">ip_range</command:parameterValue> <command:parameterValue required="false" variableLength="false">country</command:parameterValue> <command:parameterValue required="false" variableLength="false">asn</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFFirewallTarget</command:parameterValue> <dev:type><maml:name>CFFirewallTarget</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>MatchMode</maml:name> <maml:Description><maml:para>Matches only firewall rules with this mode. Options include whitelist, block, challenge, js_challenge. Default is null (match all modes) </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">whitelist</command:parameterValue> <command:parameterValue required="false" variableLength="false">block</command:parameterValue> <command:parameterValue required="false" variableLength="false">challenge</command:parameterValue> <command:parameterValue required="false" variableLength="false">js_challenge</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFFirewallMode</command:parameterValue> <dev:type><maml:name>CFFirewallMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Configuration_value</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>MatchItem</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code if matching by Target in your search. Default is null (match all items). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>MatchTarget</maml:name> <maml:Description><maml:para>Are you matching an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFFirewallTarget</command:parameterValue> <dev:type><maml:name>CFFirewallTarget</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>MatchMode</maml:name> <maml:Description><maml:para>Matches only firewall rules with this mode. Options include whitelist, block, challenge, js_challenge. Default is null (match all modes) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFFirewallMode</command:parameterValue> <dev:type><maml:name>CFFirewallMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Configuration_value</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFFirewallRule</dev:code> <dev:remarks><maml:para>Shows all cloudflare firewall rules at the top of the organization </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-CFCurrentZone 'contoso.org'</dev:code> <dev:remarks><maml:para>PS> Get-CFFirewallRule </maml:para> <maml:para>Shows all cloudflare firewall rules for the contoso.org zone. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-CFFirewallRule -MatchMode whitelist</dev:code> <dev:remarks><maml:para>Shows only whitelist firewall items </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-CFFirewallRule -MatchMode whitelist -MatchItem '4.2.2.2' -MatchScope any</dev:code> <dev:remarks><maml:para>Returns any whitelisted item that matches 4.2.2.2 </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFIP</command:name> <command:verb>Get</command:verb> <command:noun>CFIP</command:noun> <maml:description><maml:para>Returns Cloudflare IPs. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Returns Cloudflare IPs. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFIP</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFIP</dev:code> <dev:remarks><maml:para>Returns all the ipv4 and 6 Cloudflare IPs. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFPageRule</command:name> <command:verb>Get</command:verb> <command:noun>CFPageRule</command:noun> <maml:description><maml:para>List Cloudflare page rules. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare page rules. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFPageRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Rule status. Can be active, inactive, or null. Default is null (returns both active and inactive rules). </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">active</command:parameterValue> <command:parameterValue required="false" variableLength="false">disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFPageRuleStatus</command:parameterValue> <dev:type><maml:name>CFPageRuleStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by status or priority. Default is priority. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Priority</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Status</maml:name> <maml:Description><maml:para>Rule status. Can be active, inactive, or null. Default is null (returns both active and inactive rules). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFPageRuleStatus</command:parameterValue> <dev:type><maml:name>CFPageRuleStatus</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by status or priority. Default is priority. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Priority</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFPageRule</dev:code> <dev:remarks><maml:para>Shows all cloudflare Page rules for the zone. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFRequestData</command:name> <command:verb>Get</command:verb> <command:noun>CFRequestData</command:noun> <maml:description><maml:para>Gets the parameters for a request to the Cloudflare API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Gets the parameters for a request to the Cloudflare API. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFRequestData</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFTrafficLog</command:name> <command:verb>Get</command:verb> <command:noun>CFTrafficLog</command:noun> <maml:description><maml:para>List Cloudflare traffic logs. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare traffic logs. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFTrafficLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by id, action, host, ip, country, or occurred_at. Default is occurred_at. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Occurred_at</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. Max is 500. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>ResultLimit</maml:name> <maml:Description><maml:para>Maximum page results returned. Default is 0 (unlimited). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by id, action, host, ip, country, or occurred_at. Default is occurred_at. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Occurred_at</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. Max is 500. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>ResultLimit</maml:name> <maml:Description><maml:para>Maximum page results returned. Default is 0 (unlimited). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFTrafficLog</dev:code> <dev:remarks><maml:para>Shows all cloudflare firewall rules at the top of the organization </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-CFCurrentZone 'contoso.org'</dev:code> <dev:remarks><maml:para>PS> Get-CFTrafficLog </maml:para> <maml:para>Shows all cloudflare firewall rules for the contoso.org zone. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFWAFRule</command:name> <command:verb>Get</command:verb> <command:noun>CFWAFRule</command:noun> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFWAFRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>PackageID</maml:name> <maml:Description><maml:para>Package ID to query. If not supplied then all package IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GroupID</maml:name> <maml:Description><maml:para>Group ID to query. If not supplied then all group IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Description to query for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>WAF mode to query for. Can be whitelist, block, challenge, or js_challenge. Default is all modes. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">on</command:parameterValue> <command:parameterValue required="false" variableLength="false">off</command:parameterValue> <command:parameterValue required="false" variableLength="false">default</command:parameterValue> <command:parameterValue required="false" variableLength="false">disable</command:parameterValue> <command:parameterValue required="false" variableLength="false">simulate</command:parameterValue> <command:parameterValue required="false" variableLength="false">block</command:parameterValue> <command:parameterValue required="false" variableLength="false">challenge</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFWAFRuleMode</command:parameterValue> <dev:type><maml:name>CFWAFRuleMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Priority</maml:name> <maml:Description><maml:para>WAF priority to query for. Default is all priorities. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Group_id</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>PackageID</maml:name> <maml:Description><maml:para>Package ID to query. If not supplied then all package IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>GroupID</maml:name> <maml:Description><maml:para>Group ID to query. If not supplied then all group IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Description to query for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>WAF mode to query for. Can be whitelist, block, challenge, or js_challenge. Default is all modes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFWAFRuleMode</command:parameterValue> <dev:type><maml:name>CFWAFRuleMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Priority</maml:name> <maml:Description><maml:para>WAF priority to query for. Default is all priorities. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Group_id</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFWAFRule</dev:code> <dev:remarks><maml:para>Shows all cloudflare WAF rules for the zone. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFWAFRuleGroup</command:name> <command:verb>Get</command:verb> <command:noun>CFWAFRuleGroup</command:noun> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFWAFRuleGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>PackageID</maml:name> <maml:Description><maml:para>Package ID to query. If not supplied then all package IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>rule group name. If not supplied then all rule groups are returned. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>WAF rule group mode to query for. Can be on or off. Default is all modes. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">on</command:parameterValue> <command:parameterValue required="false" variableLength="false">off</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFWAFRuleGroupMode</command:parameterValue> <dev:type><maml:name>CFWAFRuleGroupMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Mode</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>PackageID</maml:name> <maml:Description><maml:para>Package ID to query. If not supplied then all package IDs are queried. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>rule group name. If not supplied then all rule groups are returned. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>WAF rule group mode to query for. Can be on or off. Default is all modes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFWAFRuleGroupMode</command:parameterValue> <dev:type><maml:name>CFWAFRuleGroupMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Mode</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFWAFRuleGroup</dev:code> <dev:remarks><maml:para>Shows all cloudflare WAF rule groups for the zone. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFWAFRulePackage</command:name> <command:verb>Get</command:verb> <command:noun>CFWAFRulePackage</command:noun> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> </command:details> <maml:description><maml:para>List Cloudflare WAF rules. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFWAFRulePackage</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>rule package name. If not supplied then all rule packages are returned. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply WAF rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>rule package name. If not supplied then all rule packages are returned. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>OrderBy</maml:name> <maml:Description><maml:para>Order the results by configuration_target, configuration_value, or mode. Default is configuration_value </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Direction</maml:name> <maml:Description><maml:para>Return results in asc (ascending) or dec (decending) order. Default is asc. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Asc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>MatchScope</maml:name> <maml:Description><maml:para>Match either 'any' or 'all' the supplied matching parameters passed to this function. Default is all. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PageLimit</maml:name> <maml:Description><maml:para>Maximum results returned per page. Default is 50. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>50</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-CFCurrentZone 'contoso.org'</dev:code> <dev:remarks><maml:para>PS> Get-CFWAFRulePackage </maml:para> <maml:para>Shows all cloudflare WAF rule packages for the contoso.org zone. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-CFZoneID</command:name> <command:verb>Get</command:verb> <command:noun>CFZoneID</command:noun> <maml:description><maml:para>Returns the ZoneID of the passed zone name (if it exists) </maml:para> </maml:description> </command:details> <maml:description><maml:para>Returns the ZoneID of the passed zone name (if it exists) </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-CFZoneID</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Zone</maml:name> <maml:Description><maml:para>Zone name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Zone</maml:name> <maml:Description><maml:para>Zone name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-CFZoneID -Zone 'contoso.com'</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Invoke-CFAPI4Request</command:name> <command:verb>Invoke</command:verb> <command:noun>CFAPI4Request</command:noun> <maml:description><maml:para>Send REST request to Cloudflare URI. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Send REST request to Cloudflare URI. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Invoke-CFAPI4Request</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Target URI to send request to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).URI</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Headers</maml:name> <maml:Description><maml:para>All the headers in hashtable format you will be sending. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The body of the REST request </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Body</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>REST method to send. Can be Head, Get, Put, Patch, Post, or Delete. Default is Get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Method</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Target URI to send request to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).URI</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Headers</maml:name> <maml:Description><maml:para>All the headers in hashtable format you will be sending. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The body of the REST request </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Body</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>REST method to send. Can be Head, Get, Put, Patch, Post, or Delete. Default is Get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>($Script:RESTParams).Method</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-CFFirewallRule</command:name> <command:verb>Remove</command:verb> <command:noun>CFFirewallRule</command:noun> <maml:description><maml:para>Removes a Cloudflare firewall rule. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Removes a Cloudflare firewall rule. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-CFFirewallRule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="id"><maml:name>RuleID</maml:name> <maml:Description><maml:para>RuleID to remove </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="id"><maml:name>RuleID</maml:name> <maml:Description><maml:para>RuleID to remove </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-CFFirewallRule -RuleID 54274c4cda768def3ca6097c95021155</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-CFCurrentZone</command:name> <command:verb>Set</command:verb> <command:noun>CFCurrentZone</command:noun> <maml:description><maml:para>Sets the currently targeted zone for other functions </maml:para> </maml:description> </command:details> <maml:description><maml:para>Sets the currently targeted zone for other functions </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-CFCurrentZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Zone</maml:name> <maml:Description><maml:para>The zone domain name </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Zone</maml:name> <maml:Description><maml:para>The zone domain name </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-CFCurrentZone -Zone 'contoso.com'</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-CFFirewallRule</command:name> <command:verb>Set</command:verb> <command:noun>CFFirewallRule</command:noun> <maml:description><maml:para>Modifies a cloudflare firewall rule. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Modifies a cloudflare firewall rule. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-CFFirewallRule</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>ID</maml:name> <maml:Description><maml:para>The firewall ID you would like to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Target</maml:name> <maml:Description><maml:para>Are you adding an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">ip</command:parameterValue> <command:parameterValue required="false" variableLength="false">ip_range</command:parameterValue> <command:parameterValue required="false" variableLength="false">country</command:parameterValue> <command:parameterValue required="false" variableLength="false">asn</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFFirewallTarget</command:parameterValue> <dev:type><maml:name>CFFirewallTarget</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>What is this rule going to do? Options include whitelist, block, challenge, js_challenge. Default is to whitelist. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">whitelist</command:parameterValue> <command:parameterValue required="false" variableLength="false">block</command:parameterValue> <command:parameterValue required="false" variableLength="false">challenge</command:parameterValue> <command:parameterValue required="false" variableLength="false">js_challenge</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CFFirewallMode</command:parameterValue> <dev:type><maml:name>CFFirewallMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Notes</maml:name> <maml:Description><maml:para>Any additional notes for the added firewall rule </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ZoneID</maml:name> <maml:Description><maml:para>You apply firewall rules to individual zones or to the whole organization. If you pass ZoneID it will be targeted otherwise the currently loaded zone from Set-CFCurrentZone is targeted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>ID</maml:name> <maml:Description><maml:para>The firewall ID you would like to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Item</maml:name> <maml:Description><maml:para>This can be an IP, IP range (Cidr notation), ASN (AS####), or 2 letter Country code </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Target</maml:name> <maml:Description><maml:para>Are you adding an IP, IP_Range, ASN, or Country? </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFFirewallTarget</command:parameterValue> <dev:type><maml:name>CFFirewallTarget</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Mode</maml:name> <maml:Description><maml:para>What is this rule going to do? Options include whitelist, block, challenge, js_challenge. Default is to whitelist. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CFFirewallMode</command:parameterValue> <dev:type><maml:name>CFFirewallMode</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>Notes</maml:name> <maml:Description><maml:para>Any additional notes for the added firewall rule </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-CFFirewallRule -ZoneID $ZoneID -Item '96.9.128.0/24' -Notes 'Load Balancer Ip Block - 4.1' -Target 'ip_range' -Mode:challenge -Verbose</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-CFRequestData</command:name> <command:verb>Set</command:verb> <command:noun>CFRequestData</command:noun> <maml:description><maml:para>Sets the parameters for a request to the Cloudflare API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Sets the parameters for a request to the Cloudflare API. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-CFRequestData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>URI</maml:name> <maml:Description><maml:para>Target URI to send request to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Headers</maml:name> <maml:Description><maml:para>All the headers in hashtable format you will be sending. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>$Script:Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The body of the REST request </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>REST method to send. Can be Head, Get, Put, Patch, Post, or Delete. Default is Get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>URI</maml:name> <maml:Description><maml:para>Target URI to send request to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Headers</maml:name> <maml:Description><maml:para>All the headers in hashtable format you will be sending. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>$Script:Headers</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The body of the REST request </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>REST method to send. Can be Head, Get, Put, Patch, Post, or Delete. Default is Get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Author: Zachary Loeber </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>TBD</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>https://github.com/zloeber/PSCloudFlare</maml:linkText> <maml:uri>https://github.com/zloeber/PSCloudFlare</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |