|
|
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Windows Management|[[:Category:ITOM|Index]]}}
| + | This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. |
| − | [[File:microsoft_logo.png|activedirectory_logo.png|300px]]
| |
| − | {{IntroAndLinks|The Windows Management package for Hornbill's IT Operations Management (ITOM) contains operations to automate the management of Services, Processes, Environment Variables and PowerShell Execution Policies on target machines.
| |
| − | |
| |
| − | <!-- Related Links go here -->
| |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| | | | |
| − | ==Target Environment Requirements==
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | | |
| − | ===Script Execution Machine Requirements===
| |
| − | | |
| − | * If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. If this is the case, you can use the Set Execution Policy operation within this package to update the Execution Policy on the target device before peforming any of the other operations.
| |
| − | ==KeySafe Configuration==
| |
| − | [[File:Itomtarget_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/d/d2/Itomtarget_keysafe.png]] | |
| − | | |
| − | When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges on the target.
| |
| − | | |
| − | To configure your '''Target Machine''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
| |
| − | | |
| − | * In the Admin console, navigate to: System > Security > KeySafe;
| |
| − | * Click on + then select <code>Username + Password</code>;
| |
| − | * Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
| |
| − | * Optionally add a description;
| |
| − | * Populate the Username field with the domain/local account username for the account being used on the target machine;
| |
| − | * Populate the Password field with the password for the above account;
| |
| − | * Select Create Key to save.
| |
| − | | |
| − | Once you have created your KeySafe Key, you can then use it when creating IT Automation Jobs from this package. See screenshots to the right for examples.
| |
| − | | |
| − | ==Package Operations==
| |
| − | | |
| − | The Windows Management package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks.
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Start===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will start a Service on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Stop===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will stop a Service on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Restart===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will restart a Service on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Get===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will retrieve information about a Service on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | * <code>displayName</code>
| |
| − | * <code>serviceType</code>
| |
| − | * <code>status</code>
| |
| − | * <code>startup</code>
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Startup Disabled===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will set the Startup Type of a Service to Disabled on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Startup Manual===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will set the Startup Type of a Service to Manual on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Services - Startup Automatic===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will set the Startup Type of a Service to Automatic on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - Name of the Service
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Environment Variable - Get===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will retrieve the value of an Environment Variable on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>EVName</code> '''(MANDATORY)''' - Name of the Environment Variable
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | * <code>value</code>
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Environment Variable - Set===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will create or overwrite the value of a System Environment Variable on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>EVName</code> '''(MANDATORY)''' - Name of the Environment Variable
| |
| − | * <code>EVValue</code> '''(MANDATORY)''' - The Value for the Environment Variable
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Environment Variable - Delete===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will delete a System Environment Variable on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>EVName</code> '''(MANDATORY)''' - Name of the Environment Variable
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Process - Get===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will retrieve the details about a running process on a Windows device. If more than one processes are found, the operation will return details about the first one found.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ProcName</code> '''(MANDATORY)''' - Name of the Process
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | * <code>id</code>
| |
| − | * <code>name</code>
| |
| − | * <code>handles</code>
| |
| − | * <code>userName</code>
| |
| − | * <code>ws</code>
| |
| − | * <code>vm</code>
| |
| − | * <code>cpu</code>
| |
| − | * <code>pm</code>
| |
| − | * <code>npm</code>
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Process - End===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will end a running process on a Windows device. If more than one processes are found using the given name, then the operation will end the first one found.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ProcName</code> '''(MANDATORY)''' - Name of the process
| |
| − | Optional (decimal) - GracefulTime</code> - The number of seconds to allow the graceful shutdown of the process, before hard-killing it
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Process - Start===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will start a running process on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>FilePath</code> '''(MANDATORY)''' - The filepath of the process
| |
| − | * <code>ArgumentList</code> - Any arguments to pass to the process
| |
| − | * <code>RedirectStandardError</code> - File that the Standard Error stream will be output to
| |
| − | * <code>RedirectStandardOutput</code> - File that the Standard Output stream will be passed to
| |
| − | * <code>WorkingDirectory - The</code> working directory for the process
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Set Execution Policy===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This operation will set the PowerShell Execution Policy on a Windows device.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>ExecPolicy</code> '''(MANDATORY)''' - AllSigned/Bypass/Default/RemoteSigned/Restricted/Undefined/Unrestricted
| |
| − | * <code>Scope</code> '''(MANDATORY)''' - MachinePolicy/UserPolicy/CurrentUser/LocalMachine
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule Disable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Disables a Windows Firewall Rule, or Group of Rules.
| |
| − | | |
| − | One of Name, DisplayName, GroupName or GroupDisplayName must be provided, and will be used to disable the specified Firewall Rule or Group of Rules.
| |
| − | | |
| − | See the Disable-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/disable-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> - Display Name of the Firewall Rule
| |
| − | * <code>GroupName</code> - Name of the Firewall Rule Group
| |
| − | * <code>GroupDisplayName</code> - Display Name of the Firewall Rule Group
| |
| − | * <code>Direction</code> - Inbound/Outbound
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule Enable===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Enables a Windows Firewall Rule, or Group of Rules.
| |
| − | | |
| − | One of Name, DisplayName, GroupName or GroupDisplayName must be provided, and will be used to enable the specified Firewall Rule or Group of Rules.
| |
| − | | |
| − | See the Enable-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/enable-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> - Display Name of the Firewall Rule
| |
| − | * <code>GroupName</code> - Name of the Firewall Rule Group
| |
| − | * <code>GroupDisplayName</code> - Display Name of the Firewall Rule Group
| |
| − | * <code>Direction</code> - Inbound/Outbound
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule Get===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Retrieves details about a Windows Firewall Rule.
| |
| − | | |
| − | One of Name or DisplayName must be provided.
| |
| − | | |
| − | See the Get-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/get-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> - Display Name of the Firewall Rule
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | * <code>name</code> - The Name of the Rule
| |
| − | * <code>displayName</code> - The Display Name of the Rule
| |
| − | * <code>description</code> - The Description of the Rule
| |
| − | * <code>displayGroup</code> - The Display Name of the Group thqt the Rule is a member of
| |
| − | * <code>group</code> - The Group that the Rule is a member of
| |
| − | * <code>enabled</code> - Is the Rule enabled
| |
| − | * <code>profile</code> - The Rule Profile
| |
| − | * <code>direction</code> - The Direction of the Rule (Inbound/Outbound)
| |
| − | * <code>action</code> - The Rule Action (Block/Allow)
| |
| − | * <code>owner</code> - The Rule Owner
| |
| − | * <code>primaryStatus</code> - The Primary Status of the Rule
| |
| − | * <code>enforcementStatus</code> - The Enforcement Status of the Rule
| |
| − | * <code>policyStoreSource</code> - The Policy Store Source
| |
| − | * <code>policyStoreSourceType</code> - The Policy Store Source Type
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule New===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Creates a new Windows Firewall Rule.
| |
| − | | |
| − | See the New-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/new-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> '''(MANDATORY)''' - Display Name of the Firewall Rule
| |
| − | * <code>Direction</code> - The Direction of the Rule (Inbound/Outbound)
| |
| − | * <code>PolicyStore</code> - The Policy Store
| |
| − | * <code>Description</code> - The Description of the Rule
| |
| − | * <code>Group</code> - The Group that the Rule is to be a member of
| |
| − | * <code>Enabled</code> - Is the Rule enabled
| |
| − | * <code>Profile</code> - The Rule Profile - Any/Domain/Private/Public/NotApplicable
| |
| − | * <code>Platform</code> - The Rule Platform
| |
| − | * <code>Action</code> - The Rule Action - NotConfigured/Block/Allow
| |
| − | * <code>EdgeTraversalPolicy</code> - The Rule Edge Traversal Policy - Allow/Block/DeferToUser/DeferToApp
| |
| − | * <code>LooseSourceMapping</code> - Use Loose Source Mapping
| |
| − | * <code>LocalOnlyMapping</code> -Use Local Only Mapping
| |
| − | * <code>Owner</code> - The Rule Owner
| |
| − | * <code>LocalAddress</code> - The LocalAddress value
| |
| − | * <code>RemoteAddress</code> - The Remote Address value
| |
| − | * <code>Protocol</code> - The Protocol value
| |
| − | * <code>LocalPort</code> - The Local Port value
| |
| − | * <code>RemotePort</code> - The Remote Port Value
| |
| − | * <code>IcmpType</code> - The ICMP Type codes
| |
| − | * <code>DynamicTarget</code> - Defines a Dynamic Target - Any/ProximityApps/ProximitySharing/WifiDirectPrinting/WifiDirectDisplay/WifiDirectDevices
| |
| − | * <code>Program</code> - The Program
| |
| − | * <code>Package</code> - The Package
| |
| − | * <code>Service</code> - The Service
| |
| − | * <code>InterfaceAlias</code> - The Interface Alias
| |
| − | * <code>InterfaceType</code> - The Interface Type - Any / Wired / Wireless / RemoteAccess
| |
| − | * <code>Encryption</code> - Specifies if Encryption in authentication is required - NotRequired/Required/Dynamic
| |
| − | * <code>OverrideBlockRules</code> - Override Block Rules
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | * <code>name</code> - The Name of the Rule
| |
| − | * <code>displayName</code> - The Display Name of the Rule
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule Remove===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Deletes a Windows Firewall Rule.
| |
| − | | |
| − | One of Name or DisplayName must be provided.
| |
| − | | |
| − | See the Remove-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/remove-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> - Display Name of the Firewall Rule
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Firewall - Rule Update===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Updates an existing Windows Firewall Rule.
| |
| − | | |
| − | One of Name, DisplayName, GroupName or GroupDisplayName must be provided, and will be used to update the specified Firewall Rule or Group of Rules.
| |
| − | | |
| − | See the Set-NetFirewallRule cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/netsecurity/set-netfirewallrule?view=win10-ps
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | None required.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> - Name of the Firewall Rule
| |
| − | * <code>DisplayName</code> - Display Name of the Firewall Rule
| |
| − | * <code>GroupName</code> - Name of the Firewall Rule Group
| |
| − | * <code>GroupDisplayName</code> - Display Name of the Firewall Rule Group
| |
| − | * <code>NewDisplayName</code> -The New Display Name of the Firewall Rule
| |
| − | * <code>Direction</code> - The Direction of the Rule (Inbound/Outbound)
| |
| − | * <code>PolicyStore</code> - The Policy Store
| |
| − | * <code>Description</code> - The Description of the Rule
| |
| − | * <code>Enabled</code> - Is the Rule enabled
| |
| − | * <code>Profile</code> - The Rule Profile - Any/Domain/Private/Public/NotApplicable
| |
| − | * <code>Platform</code> - The Rule Platform
| |
| − | * <code>Action</code> - The Rule Action - NotConfigured/Block/Allow
| |
| − | * <code>EdgeTraversalPolicy</code> - The Rule Edge Traversal Policy - Allow/Block/DeferToUser/DeferToApp
| |
| − | * <code>LooseSourceMapping</code> - Use Loose Source Mapping
| |
| − | * <code>LocalOnlyMapping</code> -Use Local Only Mapping
| |
| − | * <code>Owner</code> - The Rule Owner
| |
| − | * <code>LocalAddress</code> - The LocalAddress value
| |
| − | * <code>RemoteAddress</code> - The Remote Address value
| |
| − | * <code>Protocol</code> - The Protocol value
| |
| − | * <code>LocalPort</code> - The Local Port value
| |
| − | * <code>RemotePort</code> - The Remote Port Value
| |
| − | * <code>IcmpType</code> - The ICMP Type codes
| |
| − | * <code>DynamicTarget</code> - Defines a Dynamic Target - Any/ProximityApps/ProximitySharing/WifiDirectPrinting/WifiDirectDisplay/WifiDirectDevices
| |
| − | * <code>Program</code> - The Program
| |
| − | * <code>Package</code> - The Package
| |
| − | * <code>Service</code> - The Service
| |
| − | * <code>InterfaceAlias</code> - The Interface Alias
| |
| − | * <code>InterfaceType</code> - The Interface Type - Any / Wired / Wireless / RemoteAccess
| |
| − | * <code>Encryption</code> - Specifies if Encryption in authentication is required - NotRequired/Required/Dynamic
| |
| − | * <code>OverrideBlockRules</code> - Override Block Rules
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''(MANDATORY)''' - Can be ok/warn/fail depending on the output of the operation
| |
| − | * <code>error</code> - Any errors returned, in the event that the outcome is '''fail'''
| |
| − | * <code>warning</code> - Any warnings returned, in the event that the outcome is '''warn'''
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]]
| |
