en-US/NinjaRmmApi-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>Get-NinjaRmmAlerts</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmAlerts</command:noun> <maml:description> <maml:para>Get alerts from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve one or more alerts from NinjaRMM. With no parameters specified, all alerts will be returned. You may use -AlertId to return only a single alert, or -Since to get all alerts that have occurred after the one with that specific ID.</maml:para> <maml:para>In this version of the NinjaRMM API, alerts contain both device and customer information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmAlerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Retrieve a specific alert. This parameter is undocumented and not part of official API specification. Thus, using it in a production environment may not be a wise idea.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NinjaRmmAlerts</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Since</maml:name> <maml:Description> <maml:para>Retrieve all alerts since this last known alert ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>AlertId</maml:name> <maml:Description> <maml:para>Retrieve a specific alert. This parameter is undocumented and not part of official API specification. Thus, using it in a production environment may not be a wise idea.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>Since</maml:name> <maml:Description> <maml:para>Retrieve all alerts since this last known alert ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>Upon success, this cmdlet will return zero or more Objects containing alert data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts</dev:code> <dev:remarks> <maml:para>Retrieve all alerts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts -Since 1234567</dev:code> <dev:remarks> <maml:para>Retrieve all alerts that have happened since alert ID 1234567 was logged.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmAlerts | Where {$_.Role -eq 'WINDOWS_WORKSTATION'} | Format-List</dev:code> <dev:remarks> <maml:para>Retrieve all alerts that have happened on a Windows workstation. This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmAlerts.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-NinjaRmmAlert</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></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-NinjaRmmCustomers</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmCustomers</command:noun> <maml:description> <maml:para>Get customers from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve data about one or more customers from NinjaRMM. With no parameters specified, all available customers will be returned. You may use -CustomerId to return only a single customer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmCustomers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CustomerId</maml:name> <maml:Description> <maml:para>If specified, this will retrieve data about only this one particular customer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>CustomerId</maml:name> <maml:Description> <maml:para>If specified, this will retrieve data about only this one particular customer.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>Upon success, this cmdlet will return zero or more objects containing customer data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomers</dev:code> <dev:remarks> <maml:para>Retrieve all customers' data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomer -CustomerId 42</dev:code> <dev:remarks> <maml:para>Retrieve data about the customer with the ID number of 42. To find ID numbers, look in your NinjaRMM dashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmCustomer | Where {$_.Name -Like '*Consulting'} | Format-List</dev:code> <dev:remarks> <maml:para>Retrieve all customers whose name ends with "Consulting." This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmCustomers.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></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-NinjaRmmDevices</command:name> <command:verb>Get</command:verb> <command:noun>NinjaRmmDevices</command:noun> <maml:description> <maml:para>Gets device information from NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will retrieve one or more available devices and their information from NinjaRMM. With no parameters specified, all devices will be returned. You may use -DeviceId to return only a single device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NinjaRmmDevices</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:Description> <maml:para>Specify this parameter to retrieve data about one particular device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>DeviceId</maml:name> <maml:Description> <maml:para>Specify this parameter to retrieve data about one particular device.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>Upon success, this cmdlet will return zero or more Objects containing device data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices</dev:code> <dev:remarks> <maml:para>Retrieve a list of all available devices.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices -DeviceId 528</dev:code> <dev:remarks> <maml:para>Retrieve all information about device number 528.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-NinjaRmmDevices | Where {$_.System.Manufacturer -eq 'Hewlett-Packard'} | Out-GridView</dev:code> <dev:remarks> <maml:para>Retrieve all devices that report their manufacturer as Hewlett-Packard. This module converts the API results into native PowerShell objects that can be parsed, filtered, and manipulated with other cmdlets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Get-NinjaRmmDevices.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></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-NinjaRmmAlert</command:name> <command:verb>Reset</command:verb> <command:noun>NinjaRmmAlert</command:noun> <maml:description> <maml:para>Reset one alert in NinjaRMM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will acknowledge and reset an alert in NinjaRMM. Note that an alert may only be reset if it has the can_reset property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NinjaRmmAlert</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Specify the alert to reset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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="0" aliases="none"> <maml:name>AlertId</maml:name> <maml:Description> <maml:para>Specify the alert to reset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Before you can use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Reset-NinjaRmmAlert -AlertId 1234567</dev:code> <dev:remarks> <maml:para>Reset the alert with ID 1234567. If successful, there will be no output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmAlert.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NinjaRmmAlerts</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></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-NinjaRmmSecrets</command:name> <command:verb>Reset</command:verb> <command:noun>NinjaRmmSecrets</command:noun> <maml:description> <maml:para>Removes your NinjaRMM API keys from memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will remove the NinjaRMM access key ID and secret access key from memory. After running this cmdlet, no other NinjaRmm cmdlets will work; you will need to run Set-NinjaRmmSecrets again.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NinjaRmmSecrets</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>After you use this cmdlet, you will need to run Set-NinjaRmmSecrets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Reset-NinjaRmmSecrets</dev:code> <dev:remarks> <maml:para>Forgets the NinjaRMM secrets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmSecrets.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NinjaRmmSecrets</maml:linkText> <maml:uri></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-NinjaRmmSecrets</command:name> <command:verb>Set</command:verb> <command:noun>NinjaRmmSecrets</command:noun> <maml:description> <maml:para>Sets your NinjaRMM API keys.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet stores your NinjaRMM API access key ID and secret access key in memory. This cmdlet must be run before you can use any of the Get- or Reset- cmdlets in this module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NinjaRmmSecrets</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>AccessKeyId</maml:name> <maml:Description> <maml:para>Your NinjaRMM API access key identifier.</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="1" aliases="none"> <maml:name>SecretAccessKey</maml:name> <maml:Description> <maml:para>Your NinjaRMM API secret access key.</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="0" aliases="none"> <maml:name>AccessKeyId</maml:name> <maml:Description> <maml:para>Your NinjaRMM API access key identifier.</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="1" aliases="none"> <maml:name>SecretAccessKey</maml:name> <maml:Description> <maml:para>Your NinjaRMM API secret access key.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Your NinjaRMM API information is stored in the system's environment. It is possible for another process on your computer to see this information. If this is a concern, you may wish to run Reset-NinjaRmmSecrets when you are finished.</maml:para> <maml:para>Your NinjaRMM secrets are only stored for the current PowerShell session. For long-term storage, consider using a password manager, saving them to your profile, or storing them with the SecretManagement module.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-NinjaRmmSecrets -AccessKeyID "TF4STGMDR4H7AEXAMPLE" -SecretAccessKey "eh14c4ngchhu6283he03j6o7ar2fcuca0example"</dev:code> <dev:remarks> <maml:para>This prepares the module to access the NinjaRMM API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/rhymeswithmogul/NinjaRMM-PowerShell/blob/main/man/en-US/Reset-NinjaRmmSecrets.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-NinjaRmmSecrets</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>SecretManagement</maml:linkText> <maml:uri>https://github.com/PowerShell/SecretManagement</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-NinjaRmmServerLocation</command:name> <command:verb>Set</command:verb> <command:noun>NinjaRmmServerLocation</command:noun> <maml:description> <maml:para>Selects a NinjaRMM API server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet allows you to select a NinjaRMM API server to use. NinjaRMM has API servers located in the United States and in the European Union. By default, the US server is used, but EU residents may prefer to use a closer server for better performance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NinjaRmmServerLocation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specify a region code. At this time, there are only two hostnames available, the US server (api.ninjarmm.com) and the EU server (eu-api.ninjarmm.com).</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">US</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EU</command:parameterValue> </command:parameterValueGroup> <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="0" aliases="none"> <maml:name>Location</maml:name> <maml:Description> <maml:para>Specify a region code. At this time, there are only two hostnames available, the US server (api.ninjarmm.com) and the EU server (eu-api.ninjarmm.com).</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>It is not clear if there are any functional differences between the two hostnames. By default, this module will use the servers located in the United States.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-NinjaRmmServerLocation -Location 'EU'</dev:code> <dev:remarks> <maml:para>Switches this module to use the API servers located in the European Union.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>about_NinjaRmmApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |