en-US/Elastic.Helper-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>Deploy-EsConfig</command:name> <command:verb>Deploy</command:verb> <command:noun>EsConfig</command:noun> <maml:description> <maml:para>Deploy specified ElasticSearch Resources to ElasticSearch cluster, with dependency checks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using the provided configuration definition, deploy the defined resources to ElasticSearch.</maml:para> <maml:para>Will check all dependencies are met before deploying to ElasticSeach, and will not attempt deployment of resources for which dependencies are not met.</maml:para> <maml:para>This may be used iteratively to defined the required resouces in ElasticSearch as data is populated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Deploy-EsConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsConfig</maml:name> <maml:description> <maml:para>ElasticHelper configuration loaded using Get-EsHelperConfig.</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>ReourceType</maml:name> <maml:description> <maml:para>*Not Yet Implemented * (Optional) Type of Resource to deploy to ElasticSearch. One of:</maml:para> <maml:para>* index</maml:para> <maml:para>* pipeline</maml:para> <maml:para>* enrichmentpolicy</maml:para> <maml:para></maml:para> <maml:para>If not specified, attempts to deploy all resources without unmet dependencies.</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>ReourceName</maml:name> <maml:description> <maml:para>*Not Yet Implemented * (Optional) Name of Resource to deploy to ElasticSearch. If specified, must also specify resource type.</maml:para> <maml:para>If not specified, attempts to deploy all resources without unmet dependencies.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>PSCustomObject -> ES Helper Configuration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Success Status</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:\> $Result = Deploy-EsConfig -EsConfig $EsConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Result = Deploy-EsConfig -EsConfig $EsConfig -ResourceName 'MyPipeline' -ResourceType 'index'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsEnrichmentPolicy</command:name> <command:verb>Get</command:verb> <command:noun>EsEnrichmentPolicy</command:noun> <maml:description> <maml:para>Get the currently configured Enrichment Policy configuration on the ElasticSearch server for the specified policy name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration of the specified Enrichment Policy from the nomiated ElasticSearch server.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsEnrichmentPolicy</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>Policy</maml:name> <maml:description> <maml:para>Name of Enrichment Policy to retrieve current configuration for.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Current Enrichment Policy configuration</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:\> $EnrichPol = Get-EsEnrichmentPolicy -EsUrl http://192.168.1.10:9200 -Policy 'MyEnrichmentPolicy'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsHelperConfig</command:name> <command:verb>Get</command:verb> <command:noun>EsHelperConfig</command:noun> <maml:description> <maml:para>Import an Elastic Helper configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function loads a saved configuration, in JSON format, from a file into memory. The configuration file is expected to have a specific structure, see the examples folder in the project for details. Index, pipeline</maml:para> <maml:para>The default path used is .eshelper folder in the user's home directory (platform dependent)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsHelperConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ConfigName</maml:name> <maml:description> <maml:para>Basename of the configuration file to read in. The file is expected to be in JSON format, and will have .json appended to the filename.</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>Path</maml:name> <maml:description> <maml:para>Path where the configuration file will be found. If not specified, the .eshelper folder in the user's home path will be used.</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.String -> Configuration Name</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCustomObject (Hash) representing the configuration file contents</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The function expects to build a path to a valid JSON file containing a specific structure. An example configuration file can be found in the examples folder of the project.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $EsConf = Get-EsHelperConfig -ConfigName elasticproject</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $EsConf = Get-EsHelperConfig -ConfigName elasticproject -Path '/opt/scripts/project/etc'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsIndex</command:name> <command:verb>Get</command:verb> <command:noun>EsIndex</command:noun> <maml:description> <maml:para>Get the currently configured Index configuration on the ElasticSearch server for the specified index name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration of the specified Index from the nomiated ElasticSearch server.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsIndex</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>EsIndex</maml:name> <maml:description> <maml:para>Name of ElasticSearch Index to get current information and configuration of.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Information about the specified index on ElasticSearch Cluster</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:\> $EsIndex = Get-EsIndex -EsUrl http://192.168.1.10:9200 -EsIndex 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsIndexSettings</command:name> <command:verb>Get</command:verb> <command:noun>EsIndexSettings</command:noun> <maml:description> <maml:para>Get the currently configured Index configuration on the ElasticSearch server for the specified index name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration of the specified Index from the nomiated ElasticSearch server.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsIndexSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>IndexName</maml:name> <maml:description> <maml:para>Name of ElasticSearch Index to get current information and configuration of.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Information about the specified index on ElasticSearch Cluster</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:\> $EsIndexSettings = Get-EsIndex -EsUrl http://192.168.1.10:9200 -IndexName 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsPipeline</command:name> <command:verb>Get</command:verb> <command:noun>EsPipeline</command:noun> <maml:description> <maml:para>Get the currently configured Pipeline configuration on the ElasticSearch server for the specified index name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration of the specified Pipeline from the nomiated ElasticSearch server.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EsPipeline</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>EsIndex</maml:name> <maml:description> <maml:para>Name of ElasticSearch Index to get current information and configuration of.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Information about the specified index on ElasticSearch Cluster</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:\> $EsPipeline = Get-EsIndex -EsUrl http://192.168.1.10:9200 -EsIndex 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsEnrichmentPolicyDepends</command:name> <command:verb>Test</command:verb> <command:noun>EsEnrichmentPolicyDepends</command:noun> <maml:description> <maml:para>Test if the Enrichment Policy's Dependencies are met.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using the provided configuration definition, determine if it's dependencies are met in ElasticSearch.</maml:para> <maml:para>Will check all defined enrichment policies unless one is specified.</maml:para> <maml:para>Checks ElasticSearch to confirm that the index on which the policy is based exists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-EsEnrichmentPolicyDepends</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsConfig</maml:name> <maml:description> <maml:para>ElasticHelper configuration loaded using Get-EsHelperConfig.</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>PolicyName</maml:name> <maml:description> <maml:para>(Optional) Name of Enrichment Policy to check for unmet dependencies.</maml:para> <maml:para>If not specified, checks all defined Enrichment Policies.</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>PSCustomObject -> ES Helper Configuration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Success Status</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:\> $Result = Test-EsEnrichmentPolicyDepends -EsConfig $EsConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Result = Test-EsEnrichmentPolicyDepends -EsConfig $EsConfig -PolicyName 'MyEnrichmentPolicy'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsIndexDepends</command:name> <command:verb>Test</command:verb> <command:noun>EsIndexDepends</command:noun> <maml:description> <maml:para>Test if the Index's Dependencies are met.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using the provided configuration definition, determine if it's dependencies are met in ElasticSearch.</maml:para> <maml:para>Will check all defined indices unless one is specified.</maml:para> <maml:para>Checks ElasticSearch to confirm that the pipeline, and associated dependencies, configured for the index exists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-EsIndexDepends</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsConfig</maml:name> <maml:description> <maml:para>ElasticHelper configuration loaded using Get-EsHelperConfig.</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>IndexName</maml:name> <maml:description> <maml:para>(Optional) Name of Index to check for unmet dependencies.</maml:para> <maml:para>If not specified, checks all defined Indices.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>PSCustomObject -> ES Helper Configuration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Success Status</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:\> $Result = Test-EsIndexDepends -EsConfig $EsConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Result = Test-EsEIndexDepends -EsConfig $EsConfig -IndexName 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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-EsPipelineDepends</command:name> <command:verb>Test</command:verb> <command:noun>EsPipelineDepends</command:noun> <maml:description> <maml:para>Test if the Pipeline's Dependencies are met.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Using the provided configuration definition, determine if it's dependencies are met in ElasticSearch.</maml:para> <maml:para>Will check all defined Pipelines unless one is specified.</maml:para> <maml:para>Checks ElasticSearch to confirm that the pipeline, and associated dependencies exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-EsPipelineDepends</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsConfig</maml:name> <maml:description> <maml:para>ElasticHelper configuration loaded using Get-EsHelperConfig.</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>PipelineName</maml:name> <maml:description> <maml:para>(Optional) Name of Pipeline to check for unmet dependencies.</maml:para> <maml:para>If not specified, checks all defined Pipelines.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>PSCustomObject -> ES Helper Configuration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Success Status</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:\> $Result = Test-EsPipelineDepends -EsConfig $EsConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Result = Test-EsPipelineDepends -EsConfig $EsConfig -PipelineName 'MyPipeline'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsEnrichmentIndices</command:name> <command:verb>Update</command:verb> <command:noun>EsEnrichmentIndices</command:noun> <maml:description> <maml:para>Rebuild all Enrichment indices associated with the specified Enrichment Policy</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Each time the base/source index for an Enrichment Policy has documents added or updated, the system indices used to perform enrichment lookups need to be rebuilt.</maml:para> <maml:para>This operation triggers this task on the cluster.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsEnrichmentIndices</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>Policy</maml:name> <maml:description> <maml:para>Name of Enrichment Policy to rebuild enrichment indices for</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Result of requested operation</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:\> $EnrichPol = Update-EsEnrichmentIndices -EsUrl http://192.168.1.10:9200 -Policy 'MyEnrichmentPolicy'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsEnrichmentIndices</command:name> <command:verb>Update</command:verb> <command:noun>EsEnrichmentIndices</command:noun> <maml:description> <maml:para>Rebuild all Enrichment indices associated with the specified Index</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Each time the base/source index for an Enrichment Policy has documents added or updated, the system indices used to perform enrichment lookups need to be rebuilt.</maml:para> <maml:para>This operation triggers this task on the cluster, based on the index that is used in an enrichment policy.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsEnrichmentIndices</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsConfig</maml:name> <maml:description> <maml:para>ElasticHelper configuration loaded using Get-EsHelperConfig.</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>IndexName</maml:name> <maml:description> <maml:para>Name of Index to trigger re-indexing for.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Result of requested operation</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:\> $result = Update-EsEnrichmentIndicesFromIndex -EsUrl http://192.168.1.10:9200 -IndexName 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsEnrichmentPolicy</command:name> <command:verb>Update</command:verb> <command:noun>EsEnrichmentPolicy</command:noun> <maml:description> <maml:para>Get the currently configured Enrichment Policy configuration on the ElasticSearch server for the specified policy name</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration of the specified Enrichment Policy from the nomiated ElasticSearch server.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsEnrichmentPolicy</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>Policy</maml:name> <maml:description> <maml:para>Name of Enrichment Policy to update definition for.</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>PolicyDefinition</maml:name> <maml:description> <maml:para>Definition of Enrichment Policy to apply.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Status of operation</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>$PolicyDef = @{} $PolicyDef.Add ('match', @{}) $PolicyDef.match.Add('indices','MyIndex') $PolicyDef.match.Add('match_field','id') $PolicyDef.match.Add('enrich_fields',('name','description')) PS C:\> $EnrichPol = Update-EsEnrichmentPolicy -EsUrl http://192.168.1.10:9200 -Policy 'MyEnrichmentPolicy' -PolicyDefinition $PolicyDef</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsIndexSettings</command:name> <command:verb>Update</command:verb> <command:noun>EsIndexSettings</command:noun> <maml:description> <maml:para>Update the settings for the specified index with the provided definition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the supplied index definition to update the existing settings of the specified index.</maml:para> <maml:para>If additional settings are present on the ElasticSearch index, the new settings will merge with and override existing settings. Other settings will remain unchanged.</maml:para> <maml:para>This allows you to update just the 'number_of_replicas' setting without affecting any other settings.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsIndexSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>IndexName</maml:name> <maml:description> <maml:para>Name of ElasticSearch Index to update current configuration of.</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>IndexDefinition</maml:name> <maml:description> <maml:para>PSCustomObject defining the desired state of the index configuration</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Status of operation</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:\> $IndexDef = @{'index' = @{ 'number_of_replicas' = '0'} } PS C:\> $EnrichPol = Update-EsEnrichmentPolicy -EsUrl http://192.168.1.10:9200 -IndexName 'MyIndex' -IndexDefinition $IndexDef</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsIndexSettingsFromConfig</command:name> <command:verb>Update</command:verb> <command:noun>EsIndexSettingsFromConfig</command:noun> <maml:description> <maml:para>Update the ElasticSearch index settings with values from the config file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the supplied configuration object to update the ElasticSearch running environment.</maml:para> <maml:para>This will recursively identify required objects to create, such as Pipeline, Enrichment Policy, etc</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsIndexSettingsFromConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>IndexName</maml:name> <maml:description> <maml:para>Name of ElasticSearch Index to update current configuration of.</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>IndexDefinition</maml:name> <maml:description> <maml:para>PSCustomObject defining the desired state of the index configuration</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Status of operation</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:\> $EsConf = Get-EsHelperConfig -ConfigName 'esproject' PS C:\> $result = Update-EsIndexSettingsFromConfig -EsConf $EsConf -IndexName 'MyIndex'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</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>Update-EsPipelineSettings</command:name> <command:verb>Update</command:verb> <command:noun>EsPipelineSettings</command:noun> <maml:description> <maml:para>Update the settings for the specified Pipeline with the provided definition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use the supplied Pipeline definition to update the existing settings of the specified Pipeline.</maml:para> <maml:para>If additional settings are present on the ElasticSearch Pipeline, the new settings will merge with and override existing settings. Other settings will remain unchanged.</maml:para> <maml:para>This allows you to update just the 'number_of_replicas' setting without affecting any other settings.</maml:para> <maml:para>Optionally supports Authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-EsPipelineSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EsUrl</maml:name> <maml:description> <maml:para>Base URL for your ElasticSearch server/cluster.</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>PipelineName</maml:name> <maml:description> <maml:para>Name of ElasticSearch Pipeline to update current configuration of.</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>PipelineDefinition</maml:name> <maml:description> <maml:para>PSCustomObject defining the desired state of the Pipeline configuration</maml:para> <maml:para>This is the PSCustomObject representation of the JSON that is obtainable from the Kibana pipeline editor.</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>EsCreds</maml:name> <maml:description> <maml:para>PSCredential object containing username and password to access ElasticSearch</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>Status of operation</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:\> $EsConf = Get-EsHelperConfig -ConfigName 'esproject' PS C:\> $PipelineDef = $EsConf._ingest.pipelines[0].definition PS C:\> $EnrichPol = Update-EsEnrichmentPolicy -EsUrl http://192.168.1.10:9200 -Pipeline 'MyPipeline' -PipelineDefinition $PipelineDef</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Elastic.Helper on GitHub</maml:linkText> <maml:uri>https://github.com/jberkers42/Elastic.Helper</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |