Com.ScriptRunner.UI.ISEAddOn.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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>Disable-ISEScriptRunner</command:name> <command:verb>Disable</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Remove the ScriptRunner ISE add-on from the Windows PowerShell ISE profile of the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove the startup code of the ScriptRunner ISE add-on from the Windows PowerShell ISE profile of the current user. The ScriptRunner ISE add-on will no longer be loaded at the startup of Windows PowerShell ISE.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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>Enable-ISEScriptRunner</command:name> <command:verb>Enable</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Add the ScriptRunner ISE add-on to the Windows PowerShell ISE profile of the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add the ScriptRunner ISE add-on to the Windows PowerShell ISE profile of the current user. The ScriptRunner ISE add-on will automatically be loaded at the startup of the Windows PowerShell ISE. The Windows PowerShell ISE profile will be created, if it does not exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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-ISEScriptRunnerConfig</command:name> <command:verb>Get</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Get the current configuration of the ISEScriptRunner module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the current configuration of the ISEScriptRunner module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ISEScriptRunnerConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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>Hide-ISEScriptRunner</command:name> <command:verb>Hide</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Hide the ScriptRunner ISE add-on from the current Windows PowerShell ISE console pane.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hide the ScriptRunner ISE add-on from the current Windows PowerShell ISE console pane.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Hide-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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>Reset-SRXEnv</command:name> <command:verb>Reset</command:verb> <command:noun>SRXEnv</command:noun> <maml:description> <maml:para>Reset the global ScriptRunner PowerShell host environment variable $SRXEnv.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reset the global ScriptRunner PowerShell host environment variable $SRXEnv.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-SRXEnv</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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-ISEScriptRunnerConfig</command:name> <command:verb>Set</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Set the configuration for the ISEScriptRunner module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set the configuration for the ISEScriptRunner module.</maml:para> <maml:para>Before starting the add-on the first time, set the ScriptRunner backend URI to connect to your ScriptRunner host. You can find the required URI in the ScriptRunner Portal. Click the info button at the top right to open the About ScriptRunner window.</maml:para> <maml:para>You can also configure the file path to the pwsh executable.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ISEScriptRunnerConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Set the URI of the ScriptRunner WebAPI service. Example: 'http://localhost/scriptrunner/'</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>PwshExeFilepath</maml:name> <maml:description> <maml:para>Set the file path of the pwsh executable file. Example: 'C:\Program Files\PowerShell\7\pwsh.exe'</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="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Set the URI of the ScriptRunner WebAPI service. Example: 'http://localhost/scriptrunner/'</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>PwshExeFilepath</maml:name> <maml:description> <maml:para>Set the file path of the pwsh executable file. Example: 'C:\Program Files\PowerShell\7\pwsh.exe'</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This version of the ScriptRunner ISE add-on only supports the ScriptRunner WebAPI service of the major release 6 starting from version 6.8. The ScriptRunner ISE add-on can only be used with Windows-integrated Negotiate/Kerberos/NTLM authentication. Authentication via Microsoft Entra ID or other identity providers is not available.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-ISEScriptRunnerConfig -BackendUri 'https://myhost.mydomain.net/scriptrunner/'</dev:code> <dev:remarks> <maml:para>Set the URI of the ScriptRunner WebAPI service to 'https://myhost.mydomain.net/scriptrunner/'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ISEScriptRunnerConfig -PwshExeFilepath 'C:\Program Files\PowerShell\7-preview\pwsh.exe'</dev:code> <dev:remarks> <maml:para>Set the file path of the pwsh executable file to 'C:\Program Files\PowerShell\7-preview\pwsh.exe'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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>Start-ISEScriptRunner</command:name> <command:verb>Start</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Open the ScriptRunner ISE add-on in the current Windows PowerShell ISE console pane.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Open the ScriptRunner ISE add-on in the current Windows PowerShell ISE console pane.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before starting the add-on the first time, use the `Set-ISEScriptRunnerConfig` cmdlet to set the ScriptRunner backend URI to connect to your ScriptRunner host. You can find the required URI in the ScriptRunner Portal. Click the info button at the top right to open the About ScriptRunner window. This version of the ScriptRunner ISE add-on only supports the ScriptRunner WebAPI service of the major release 6 starting from version 6.8. The ScriptRunner ISE add-on can only be used with Windows-integrated Negotiate/Kerberos/NTLM authentication. Authentication via Microsoft Entra ID or other identity providers is not available.</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</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>Test-ISEScriptRunnerConfig</command:name> <command:verb>Test</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Test if the configuration settings of the ISEScriptRunner module are valid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test if the configuration settings of the ISEScriptRunner module are valid. Test if the URI of the ScriptRunner WebAPI service is reachable. Test if the file path to the pwsh executable file exists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-ISEScriptRunnerConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Test if the URI of the ScriptRunner WebAPI service is reachable.</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="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Test if the file path to the pwsh executable file exists.</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="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Test if the URI of the ScriptRunner WebAPI service is reachable.</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="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Test if the file path to the pwsh executable file exists.</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="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.</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:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://support.scriptrunner.com/articles/coding/ise-add-on</maml:linkText> <maml:uri>https://support.scriptrunner.com/articles/#!coding/ise-add-on</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |