Metadata-Version: 2.1
Name: cohesity_management_sdk
Version: 1.15.1
Summary: This SDK provides operations for interfacing with the Cohesity Cluster.
Home-page: https://github.com/cohesity/management-sdk-python
Author: Cohesity Inc.
Author-email: support@cohesity.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE

Cohesity Management SDK
=================
[![License: Apache2](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/cohesity/management-sdk-python/blob/master/LICENSE)
![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cohesity/management-sdk-python?include_prereleases)
![PyPI - Downloads](https://img.shields.io/pypi/dm/cohesity_management_sdk)
![Maintenance](https://img.shields.io/maintenance/yes/2024)
## Overview

The *Cohesity Management SDK*  provides an easy-to-use language binding to
harness the power of *Cohesity REST APIs* in your python applications.

## Table of contents :scroll:

 - [Getting Started](#get-started)
 - [Cluster Version and Compatibility Matrix](#compatibility-matrix)
 - [Documentation](#documentation)
 - [How to use](#howto)
 - [More samples](#sample)
 - [How can you contribute](#contribute)
 - [Suggestions and Feedback](#suggest)
 

## <a name="get-started"></a> Let's get started :hammer_and_pick:

### Installation

Install via pip:
```
pip install cohesity-management-sdk
```


### Upgrade

To upgrade the package:

```
 pip install cohesity-management-sdk --upgrade
```

To upgade the package to specific release:

```
pip install cohesity-management-sdk==1.15.1
```
## <a name="compatibility-matrix"></a> Compatibility Matrix

| Cluster Version | SDK Version |
|-----------------|-------------|
| 6.5.1b_ent      | 1.6.6       |
| 6.6.0d_ent      | 1.6.9       |
| 7.1.2           | 1.11.0      |
| 7.1.2_u1        | 1.11.5      |
| 7.1.2_u3        | 1.12.4      |
| 7.1.2_u3_p5     | 1.12.5      |
| 7.1.2_u4        | 1.13.1      |
| 7.1.2_u5        | 1.14.1      |
| 7.3.2_u1        | 1.15.1      |


## <a name="documentation"></a> Documentation :books:

<a href="https://developer.cohesity.com/versions.html">Refer Python docs for your cluster version. </a>

## <a name="howto"></a> How to Use: :mag_right:

This SDK exposes all the functionality provided by *Cohesity REST API*.

Initializing the Client using `username` and `password`:
```
import cohesity_management_sdk.cohesity_client

username = 'Username'
password = 'Password'
domain = 'Domain' #optional
cluster_vip = 'prod-cluster.eng.cohesity.com'

client = cohesity_management_sdk.cohesity_client.CohesityClient(
    cluster_vip, username, password, domain
)
cluster_controller = client.cluster

result = cluster_controller.get_basic_cluster_info()
result_dict = result.__dict__
print(result_dict["cluster_software_version"])

#OUTPUT
6.4.1_release-20191219_aafe3274
```
---

## <a name="sample"></a> More sample code to get going: :bulb:

Check out the scripts included under [`samples`](https://github.com/cohesity/management-sdk-python/tree/master/samples) for reference.

## <a name="contribute"></a> Contribute :handshake:

* [Refer our contribution guideline](./CONTRIBUTING.md).


## <a name ="suggest"></a> Questions or Feedback :raised_hand:

We would love to hear from you. Please send your questions and feedback via Cohesity support portal: *https://www.cohesity.com/support/*

