{"id":14980461,"url":"https://github.com/gigi81/elastico","last_synced_at":"2025-10-29T00:30:38.161Z","repository":{"id":142867118,"uuid":"64006890","full_name":"gigi81/elastico","owner":"gigi81","description":"Powershell module for Elasticsearch","archived":false,"fork":false,"pushed_at":"2020-09-13T09:28:52.000Z","size":1609,"stargazers_count":28,"open_issues_count":0,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-01T20:11:26.855Z","etag":null,"topics":["backup","cmdlet","dotnet-core","elasticsearch","linux","powershell","powershell-cmdlets","powershell-core","powershell-gallery","powershell-module","search","windows"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gigi81.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-23T08:26:59.000Z","updated_at":"2021-06-11T21:04:39.000Z","dependencies_parsed_at":"2023-04-19T10:17:07.070Z","dependency_job_id":null,"html_url":"https://github.com/gigi81/elastico","commit_stats":{"total_commits":175,"total_committers":1,"mean_commits":175.0,"dds":0.0,"last_synced_commit":"afd9ca342bc126b94aee5e0d7505d0d03d1932b2"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gigi81%2Felastico","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gigi81%2Felastico/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gigi81%2Felastico/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gigi81%2Felastico/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gigi81","download_url":"https://codeload.github.com/gigi81/elastico/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238743913,"owners_count":19523201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","cmdlet","dotnet-core","elasticsearch","linux","powershell","powershell-cmdlets","powershell-core","powershell-gallery","powershell-module","search","windows"],"created_at":"2024-09-24T14:01:48.578Z","updated_at":"2025-10-29T00:30:32.626Z","avatar_url":"https://github.com/gigi81.png","language":"C#","readme":"[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/elastico.svg?style=flat)](https://www.powershellgallery.com/packages/Elastico)\n[![Build Status](https://luigigrilli.visualstudio.com/elastico/_apis/build/status/gigi81.elastico?branchName=master)](https://luigigrilli.visualstudio.com/elastico/_build/latest?definitionId=7\u0026branchName=master)\n\n# Elastico\n\nElastico is a Powershell module that allows to perform some operations with an Elasticsearch cluster. The module can run on both Windows and Linux and runs on both legacy Desktop Powershell 5.1 and Powershell core 6+\n\nInstall\n============\n\nYou can install the module from the [powershell gallery](https://www.powershellgallery.com/packages/Elastico) from the command line by running the following command:\n```powershell\nInstall-Module Elastico\n```\n\nFeatures\n============\n\nThe current version of the module supports the following functionalities:\n- get cluster health\n- get cluster info\n- search\n- get/set index settings\n- list/add/remove indices\n- list/add/remove repositories (for backup)\n- list/add/remove snapshots (for backup)\n\nDocumentation\n============\n\nDocumentation is available on [github pages](https://gigi81.github.io/elastico/#Get-ElasticClusterHealth)\n\nElasticsearch Versions(s) Compatibility\n============\n\nThe module supports versions 2, 5, 6 and 7 of elasticsearch.\n\nBecause the server API can change between versions, for compatibility reasons, the cmdlets are specific to each single version of elasticsearch supported.\n\nSo for example, instead of having a single Get-ElasticClusterHealt cmdlet, there are 3 cmdlets, more specifically:\n- Get-ElasticV2ClusterHealth\n- Get-ElasticV5ClusterHealth\n- Get-ElasticV6ClusterHealth\n- Get-ElasticV7ClusterHealth\n\nIn order to avoid compatibility issues, you will need to know in advance the version of elasticsearch that you are dealing with, and use the relevant cmdlet.\n\nSupport for version 1 of Elasticsearch has been dropped, but you can still download an older version of the module (0.6.x) if you need to connect to an elasticsearch v1.\n\n---\n**NOTE**\n\nWhen using the module in powershell core, once you start using a version of the cmdlets, you cannot switch to another version as you will get an error (ex if you use V6 cmdlet and then start using a V7 cmdlets). You will need to close the current powershell session or start a new session.\nThis is a know issue and there is no planned fix as this is by design of powershell core.\n---\n\n\nUsage Examples\n============\n\nTo get a cluster health status\n\n```powershell\nGet-ElasticV2ClusterHealth -Node \"http://localhost:9200\"\n\nActivePrimaryShards  : 0\nActiveShards         : 0\nName                 : elasticsearch\nInitializingShards   : 0\nNumberOfDataNodes    : 1\nNumberOfNodes        : 1\nNumberOfPendingTasks : 0\nRelocatingShards     : 0\nUnassignedShards     : 0\nStatus               : green\n```\n\nTo get the list of indices available in a cluster\n\n```powershell\nGet-ElasticV2Index -Node \"http://localhost:9200\" | Format-Table -Property Name,Status\n\nName      Status\n----      ------\ntestindex open\n```\n\nTo create a new index\n\n```powershell\nNew-ElasticV2Index -Node \"http://localhost:9200\" -Index \"testindex\"\n\nDocsCount        : 0\nDocsDeleted      : 0\nHealth           : red\nName             : testindex\nPrimary          : 5\nPrimaryStoreSize :\nReplica          : 1\nStatus           : open\nStoreSize        :\nTotalMemory      :\n```\n\nTo list all command supported by the module\n\n```powershell\nGet-Command -Module Elastico\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgigi81%2Felastico","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgigi81%2Felastico","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgigi81%2Felastico/lists"}