# ITAdvisor Client
<br>
An unoffical ITAdvisor API Client.<br>
<br>
All capabilities available in the API are supported by this module.<br>
<br>
<u><b>Supported IT Advisor Versions:</b></u><br>
- 9.4.4
## Installation
```
pip install itadvisor-client
```
## Documentation
Example:
```
from itadvisor_client import ITAdvisor
# Mr. Robot Inspired Connection Details
ita_client = ITAdvisor(
host = "itadvisor.evilcorp.com"
username = "ealderson"
password = "fS0c13tY"
)
my_genome = ita_client.genomes.get_genomes_by_id(genome_id="9ecca877-7b9f-45e8-ac69-929b5ff87b7e")
```
## Classes and Functions
**assets**
- in-progress
**audit_trail**
- in-progress
**authentication**
- in-progress
**autentication_servers**
- in-progress
**backup**
- list_backup_files()
- download_backup_file(file_name:str, download_directory:str)
- upload_backup_file(backup_file:str)
- get_backup_settings()
- update_backup_settings(backup_retention_days:int, backup_location:str, fail_if_not_mounted:bool, backup_cleanup_enabled:bool)
- trigger_restore(backup_file_name:str)
- trigger_backup(backup_prefix:str="custom_")
**certificates**
- get_certificates()
- add_certificate(certificate:str)
- delete_certificate(certificate:str)
**change_request**
- in-progress
**change_request_template**
- in-progress
**configuration**
- in-progress
**custom_properties**
- get_definitions()
- get_templates()
- check_usage(cp_name:str, cp_value:str)
- get_item_cp(item_id:str)
**customers**
- in-progress
**customers_count**
- get_customers_count(root_location_id, only_active:bool=None, only_with_users:bool=None)
**equipment_browser**
- in-progress
**etl_configuration**
- in-progress
**genomes**
- get_genomes(query:str=None, query_types:list=[], genomes:list=[], genome_source:str=None)
- get_genome_by_id(genome_id:str, genome_library:str=None)
**kpis**
- in-progress
**licenses**
- get_licenses()
- add_license(license_key:str)
- delete_license(license_key:str)
**mail**
- in-progress
**platform_status**
- get_job_queue()
- get_job_status()
**power_capacity**
- in-progress
**power_path**
- in-progress
**routing**
- in-progress
**sensor_mapping**
- in-progress
**struxure_on**
- in-progress
**svg**
- Schneider Electric states DO NOT USE.
**user_groups**
- in-progress
**user_message**
- in-progress
**users**
- in-progress
**work_orders**
- in-progress
Raw data
{
"_id": null,
"home_page": null,
"name": "itadvisor-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "struxureware, ecostruxure, schneider-electric, apc, dco, ita, itadvisor, data center operation",
"author": null,
"author_email": "David Romero <dromero@dromero.dev>",
"download_url": "https://files.pythonhosted.org/packages/73/4d/7731aa10978dab367e54503514677ce09592e19ad0546b9255250b282073/itadvisor_client-0.0.21.tar.gz",
"platform": null,
"description": "# ITAdvisor Client\n<br>\nAn unoffical ITAdvisor API Client.<br> \n<br>\nAll capabilities available in the API are supported by this module.<br>\n<br>\n<u><b>Supported IT Advisor Versions:</b></u><br>\n- 9.4.4\n\n## Installation\n```\npip install itadvisor-client\n```\n\n## Documentation\nExample:\n```\nfrom itadvisor_client import ITAdvisor\n\n# Mr. Robot Inspired Connection Details\nita_client = ITAdvisor(\n host = \"itadvisor.evilcorp.com\"\n username = \"ealderson\"\n password = \"fS0c13tY\"\n)\n\nmy_genome = ita_client.genomes.get_genomes_by_id(genome_id=\"9ecca877-7b9f-45e8-ac69-929b5ff87b7e\")\n\n```\n## Classes and Functions\n**assets**\n- in-progress\n\n**audit_trail**\n- in-progress\n\n**authentication**\n- in-progress\n\n**autentication_servers**\n- in-progress\n\n**backup**\n- list_backup_files()\n- download_backup_file(file_name:str, download_directory:str)\n- upload_backup_file(backup_file:str)\n- get_backup_settings()\n- update_backup_settings(backup_retention_days:int, backup_location:str, fail_if_not_mounted:bool, backup_cleanup_enabled:bool)\n- trigger_restore(backup_file_name:str)\n- trigger_backup(backup_prefix:str=\"custom_\")\n\n**certificates**\n- get_certificates()\n- add_certificate(certificate:str)\n- delete_certificate(certificate:str)\n\n**change_request**\n- in-progress\n\n**change_request_template**\n- in-progress\n\n**configuration**\n- in-progress\n\n**custom_properties**\n- get_definitions()\n- get_templates()\n- check_usage(cp_name:str, cp_value:str)\n- get_item_cp(item_id:str)\n\n**customers**\n- in-progress\n\n**customers_count**\n- get_customers_count(root_location_id, only_active:bool=None, only_with_users:bool=None)\n\n**equipment_browser**\n- in-progress\n\n**etl_configuration**\n- in-progress\n\n**genomes**\n- get_genomes(query:str=None, query_types:list=[], genomes:list=[], genome_source:str=None)\n- get_genome_by_id(genome_id:str, genome_library:str=None)\n\n**kpis**\n- in-progress\n\n**licenses**\n- get_licenses()\n- add_license(license_key:str)\n- delete_license(license_key:str)\n\n**mail**\n- in-progress\n\n**platform_status**\n- get_job_queue()\n- get_job_status()\n\n**power_capacity**\n- in-progress\n\n**power_path**\n- in-progress\n\n**routing**\n- in-progress\n\n**sensor_mapping**\n- in-progress\n\n**struxure_on**\n- in-progress\n\n**svg**\n- Schneider Electric states DO NOT USE.\n\n**user_groups**\n- in-progress\n\n**user_message**\n- in-progress\n\n**users**\n- in-progress\n\n**work_orders**\n- in-progress\n",
"bugtrack_url": null,
"license": null,
"summary": "A python client for the Schneider Electric application IT Advisor.",
"version": "0.0.21",
"project_urls": {
"Issues": "https://github.com/dl-romero/itadvisor_client/issues",
"LinkedIn": "https://www.linkedin.com/in/dromero1/",
"Repository": "https://github.com/dl-romero/itadvisor_client"
},
"split_keywords": [
"struxureware",
" ecostruxure",
" schneider-electric",
" apc",
" dco",
" ita",
" itadvisor",
" data center operation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2cf97c95e131a1cd3a5c136d886c64c884edaf8575f3a15265c07b84aa8d889f",
"md5": "8fd05f51d051970dd8dcad7ea37c02eb",
"sha256": "69545299637e8a460d39a72a26714e58131d51ba6f9791a508d718dcb60bd03b"
},
"downloads": -1,
"filename": "itadvisor_client-0.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fd05f51d051970dd8dcad7ea37c02eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 26285,
"upload_time": "2024-09-14T02:45:52",
"upload_time_iso_8601": "2024-09-14T02:45:52.796385Z",
"url": "https://files.pythonhosted.org/packages/2c/f9/7c95e131a1cd3a5c136d886c64c884edaf8575f3a15265c07b84aa8d889f/itadvisor_client-0.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "734d7731aa10978dab367e54503514677ce09592e19ad0546b9255250b282073",
"md5": "0a7f6f59ad9ee2313635d2cf5b2abd39",
"sha256": "aed6010c068f647596cb76fdc1da21a911d13fc49251a5922a635bb5fc9612d0"
},
"downloads": -1,
"filename": "itadvisor_client-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "0a7f6f59ad9ee2313635d2cf5b2abd39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13750,
"upload_time": "2024-09-14T02:45:54",
"upload_time_iso_8601": "2024-09-14T02:45:54.072431Z",
"url": "https://files.pythonhosted.org/packages/73/4d/7731aa10978dab367e54503514677ce09592e19ad0546b9255250b282073/itadvisor_client-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 02:45:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dl-romero",
"github_project": "itadvisor_client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "itadvisor-client"
}
JSON
