en-US/FreshService.Tools-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-FsAgent</command:name> <command:verb>Get</command:verb> <command:noun>FsAgent</command:noun> <maml:description> <maml:para>Get details of a Agent, or a list of all Agents</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Agent, given the name or Id. If neither are provided, all Agents are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAgent</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Display Id of the Agent (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Name of the Agent</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Email</maml:name> <maml:description> <maml:para>Email Address of the Agent</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of agents *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the agent fields, which can be obtained from the Supported Agent Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an agent either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Joe Bloggs"</dev:code> <dev:remarks> <maml:para>Get details of Agent named Joe Bloggs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 007</dev:code> <dev:remarks> <maml:para>Get details of Agent with Id 007.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Email 'joe.bloggs@domain.com'</dev:code> <dev:remarks> <maml:para>Get details of Agent with e-mail address joe.bloggs@domain.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgent -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Agents.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Agents</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#agent_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsAgentGroup</command:name> <command:verb>Get</command:verb> <command:noun>FsAgentGroup</command:noun> <maml:description> <maml:para>Get details of a Agent, or a list of all Agents</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Agent Group, given the name or Id. If neither are provided, all Agents are returned. If no match on Name, $null is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAgentGroup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Id of the Agent Group (the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Name of the Agent Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Level 1"</dev:code> <dev:remarks> <maml:para>Get details of Agent Group named Level 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 066</dev:code> <dev:remarks> <maml:para>Get details of Agent Group with Id 066.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAgentGroup -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Agent Groups.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Agent Groups</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#groups</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsAsset</command:name> <command:verb>Get</command:verb> <command:noun>FsAsset</command:noun> <maml:description> <maml:para>Get details of a Asset, or a list of all Assets</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Asset, given the name or Id. If neither are provided, all Assets are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Display Id of the Asset (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Name of the Asset</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of Assets *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the Asset fields, which can be obtained from the Supported Asset Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an Asset either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name "Server1"</dev:code> <dev:remarks> <maml:para>Get details of Asset named Joe Bloggs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 23</dev:code> <dev:remarks> <maml:para>Get details of Asset with Id 007.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsAsset -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Assets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Assets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Asset_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsAsset</command:name> <command:verb>Get</command:verb> <command:noun>FsAsset</command:noun> <maml:description> <maml:para>Get details of an Asset Type, or a list of all Asset Types</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of the Asset Type given the Id. If the Id is not provided, all Asset Types are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Internal Id of the Asset Type</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsAssetTypes -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 1001</dev:code> <dev:remarks> <maml:para>Get details of Asset Type with Id 1001.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsAssetTypes -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Asset Typess.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Assets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Asset_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsChange</command:name> <command:verb>Get</command:verb> <command:noun>FsChange</command:noun> <maml:description> <maml:para>Get details of a Change, or a list of all Changes</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a Change, given the Id. Matching changes if using UpdatedSince. If neither are provided, all Changes are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsChange</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Display Id of the Change (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</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>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -UpdatedSince 2021-08-23</dev:code> <dev:remarks> <maml:para>Get a list of all changes updated since 2012-08-23 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 42</dev:code> <dev:remarks> <maml:para>Get details of Change with Id 42.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsChange -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Change_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsChangeFields</command:name> <command:verb>Get</command:verb> <command:noun>FsChangeFields</command:noun> <maml:description> <maml:para>Get details of the fields available/requuired for a Change</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a field available or required for a Change, given the Id or Name. If neither are provided, all Change Form Fields are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsChangeFields</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</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>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name 'external_reference'</dev:code> <dev:remarks> <maml:para>Get details about the Change Field named external_reference</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 8009</dev:code> <dev:remarks> <maml:para>Get details of Change Field= with Id 8009.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsChangeFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Change Fields.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Change_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsTicket</command:name> <command:verb>Get</command:verb> <command:noun>FsTicket</command:noun> <maml:description> <maml:para>Get details of a Ticket, or a list of all Tickets</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a Ticket, given the Id. Matching Tickets if using UpdatedSince or Filter. If none are provided, all Tickets are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicket</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Display Id of the Ticket (not the internal ID that FreshService uses)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>UpdatedSince</maml:name> <maml:description> <maml:para>List all ticket since this Date/Time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Filter</maml:name> <maml:description> <maml:para>Filter Query for list of Tickets *Note: *</maml:para> <maml:para>1. Query can be framed using the name of the agent fields, which can be obtained from the Supported Agent Fields Section. 1. Logical operators AND, OR along with parenthesis( ) can be used to group conditions. 1. Relational operators greater than or equal to :> and less than or equal to :< can be used along with date fields and numeric fields. 1. Input for date field should be in UTC Format. 1. To filter for fields with no values assigned, use the null keyword. 1. Please note that any update made to an agent either in Freshservice application or through API may take a few minutes to get indexed, after which the updated results will be available through API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</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>Only the output of the -Id operations outputs custom fields associated to the Ticket. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -UpdatedSince 2021-08-23</dev:code> <dev:remarks> <maml:para>Get a list of all Tickets updated since 2012-08-23 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 42</dev:code> <dev:remarks> <maml:para>Get details of Ticket with Id 42.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicket -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Tickets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Tickets</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsTicketFieldChoice</command:name> <command:verb>Get</command:verb> <command:noun>FsTicketFieldChoice</command:noun> <maml:description> <maml:para>Get the list of choices available for a field in a Ticket</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the list of available values for a field, or $null if all values are valid.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicketFieldChoice</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</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>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'source' -Id 2 id value -- ----- 2 Portal</dev:code> <dev:remarks> <maml:para>Get the details of the choice for the source field with an id of 2</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'status' -name 'New' id value requester_display_value -- ----- ----------------------- 6 New Waiting to be Processed</dev:code> <dev:remarks> <maml:para>Get details of the choice with a value of 'New' in the status field</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFieldChoice -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -FieldName 'my_custom_field' id display_id value -- ---------- ----- 75000100003 3 Value 1 75000100004 4 Value 2 75000100005 5 Value 3 75000100009 6 Value 4 75000100006 7 Value 5</dev:code> <dev:remarks> <maml:para>List all possible values for a custom field named my_custom_field</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FsTicketFields</command:name> <command:verb>Get</command:verb> <command:noun>FsTicketFields</command:noun> <maml:description> <maml:para>Get details of the fields available/requuired for a Ticket</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets details of a field available or required for a Ticket, given the Id or Name. If neither are provided, all Ticket Form Fields are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FsTicketFields</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The base URI of your FreshService instance. Usually hxxps://domain.freshservice.com/api/v2 .</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the API Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Id</maml:name> <maml:description> <maml:para>Internal Id of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Name</maml:name> <maml:description> <maml:para>Field Name of the Change</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Can take Pipeline input if the PipeLine objects include the id property.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int</maml:name> </dev:type> <maml:description> <maml:para>A single Int, or a List of Ints may be used as Pipeline Input.</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>Only the output of the -Id operations outputs custom fields associated to the change. These are not included on the List outputs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Name 'external_reference'</dev:code> <dev:remarks> <maml:para>Get details about the Ticket Field named external_reference</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential) -Id 8009</dev:code> <dev:remarks> <maml:para>Get details of Ticket Field with Id 8009.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:> Get-FsTicketFields -Uri "https://domain.freshservice.com/api/v2" -FsApiKey (Get-PSCredential)</dev:code> <dev:remarks> <maml:para>Get details of all Ticket Fields.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService API Documentation for Changes</maml:linkText> <maml:uri>https://api.freshservice.com/v2/#Ticket_attributes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</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-FreshServiceAlertRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>FreshServiceAlertRequest</command:noun> <maml:description> <maml:para>Send an alert message to the FreshService Alert Interface.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Send an Alert Message to a FreshService Alert Profile. This allows FreshService to manage escalation and recovery processes, including creating tickets and updating their status as additional alerts are received. Avoids the creation of duplicate tickets when repeat notifications are generated for the same item.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-FreshServiceAlertRequest</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The alert integration URL for the specific Alert Integration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>Credential</maml:name> <maml:description> <maml:para>PSCredential Object containing the Auth Key in the Password field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>AlertBody</maml:name> <maml:description> <maml:para>A psobject or Hash containing the elements to be sent as part of the alert. Will be converted to JSON before sending.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></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>*Alert Management overview *</maml:para> <maml:para>Freshservice allows you to seamlessly integrate with multiple monitoring tools and triage all your alert information in one place. The incoming alerts are then intelligently grouped to help you cut through the noise and quickly get to the bottom of the issue. You can also set up alert rules to automatically create actionable-incidents and notify your team to begin immediate resolution. Know more (https://support.freshservice.com/en/support/solutions/articles/50000002885-alert-management-in-freshservice-an-overview) *What is an alert profile? *</maml:para> <maml:para>Alert profiles allow you to integrate with one or more monitoring tools and help you consolidate alerts impacting a specific business or technical service. *Integrations *</maml:para> <maml:para>FreshService provides Out-of-the-Box integrations for a number of common systems, including:</maml:para> <maml:para>* SolarWinds NPM (Orion)</maml:para> <maml:para>* Microsoft Azure - Metric Alerts</maml:para> <maml:para>* NagiosXI</maml:para> <maml:para>* Google Cloud Monitor</maml:para> <maml:para>* Microsoft SCOM</maml:para> <maml:para>* PRTG Network Monitor</maml:para> <maml:para>* ZABBIX</maml:para> <maml:para>* ManageEngine OpManager</maml:para> <maml:para>* Custom Integration</maml:para> <maml:para></maml:para> <maml:para>The list is being regularly expanded, and where a standard integration does not suit requirements, the Custom Integration may be used to implement exactly what you need. *Custom Integration *</maml:para> <maml:para>Each integration works by specifying a JSON body to define the alert content, with a Custom Integration allowing complete control of the JSON Body Content.</maml:para> <maml:para>The JSON body fields are then mapped to Alert Fields within FreshService. The following FreshService AlertFields are available ( italics are mandatory): Resource* - Denotes the name of the monitored entity. It could be the Hostname, Application Name or Service name, based on the monitored entity. Metric Name* - The performance aspect of the resource that is monitored : CPU utilisation, Throughput, etc * Metric Value - Value of the monitored metric</maml:para> <maml:para>* Node - Denotes the MAC Address or IP Address of the machine</maml:para> <maml:para>* Message - The message that denotes the context of the alert</maml:para> <maml:para>* Description - Description of the issue Severity* - Severity denotes the impact and the urgency with which it should be acted upon. * Tags - Tags help you classify incoming alerts using keywords</maml:para> <maml:para>* Additional Information - Select up to 5 fields with additional information about the alert</maml:para> <maml:para>* Occurrence time - Time of creation of the alert</maml:para> <maml:para></maml:para> <maml:para>The severity values provided by the integrated solution are then mapped to severities within FreshService. A Severity of OK is used to reset the alert. *Authorization *</maml:para> <maml:para>To authorize the integration, copy the Endpoint URL and Auth Header values to be used with the call. The Auth Header should be stored securely, hence using this as a PSCredential object with this function. Only store the auth-key value in the PSCredential object, not the entire Auth Header provided by FreshService.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$AlertURL = 'https://domain.au-alerts.freshservice.com/alert_profiles/50000000000/integrations/50000000000/alerts' $AlertCred = Get-Credential -Username 'FreshService Alerts Auth Key' > PowerShell credential request > Enter your credentials. > Password for user FreshService Alerts Auth Key: ************************************************************************ $AlertBody = @{} $AlertBody.Add('Severity','high') $AlertBody.Add('Node',$Hostname) $AlertBody.Add('MetricName',$Metric) $AlertBody.Add('Message', $Message) $AlertBody.Add('Description', $Description) $AlertBody.Add('AlertTime', $AlertTime) Invoke-FreshServiceAlertRequest -Uri $AlertUrl -Credential $AlertCred -Body $AlertBody</dev:code> <dev:remarks> <maml:para>Send an alert message to a FreshService Alert integration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>FreshService Alert Management</maml:linkText> <maml:uri>https://support.freshservice.com/en/support/solutions/articles/50000002885-alert-management-in-freshservice-an-overview</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>FreshService Tools Project</maml:linkText> <maml:uri>https://melsgl01.soc.ipsec.net.au/vendors/freshservice/FreshService.Tools</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |