Metadata-Version: 2.4
Name: SOLIDserverCLI
Version: 0.4.1
Summary: EfficientIP SOLIDserver cli
Home-page: https://gitlab.com/efficientip/cli-for-solidserver
Author: Alex Chauvin
Author-email: ach@efficientip.com
License: BSD 2-Clause License
        
        Copyright (c) 2016, Alexis Savin
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: GitHub, https://gitlab.com/efficientip/cli-for-solidserver
Project-URL: Changelog, https://gitlab.com/efficientip/cli-for-solidserver/-/raw/master/CHANGELOG.md
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: System :: Networking
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: rich
Requires-Dist: SOLIDserverRest
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# SOLIDserver cli

This package contains a command to manage the SOLIDserver and its objects.

## install

* in a virtual environment
* install the package: `pip install SOLIDserverCLI`
* configure the access to the SOLIDserver by creating a file named `sds.ini` which contains:

```text
[server]
name = server
token_id = xxx
token_key = yyy
```

## Usage

The command `sds` can be used directly from the shell. It is organized with commands and subcommands, you can at each level add the `--help` option to get more information.

By using the `--json` at the top level, all outputs will be in the json format, providing the ability to use jq to manipulate the result.

Examples:

```text
> sds server status
SOLIDserver: sds-test.intranet, authentication: token, version: 8.4.2, timeout: 10s

> sds --json server status
{"host": "sds-test.intranet", "auth_method": "token", "timeout": 10, "version": "8.4.2", "user": "ukn (token)"}
```

## Commands

```text
├─ server
│  └─ status
└─ ipam
   ├─ space
   │  ├─ create
   │  ├─ info
   │  ├─ update
   │  ├─ delete
   │  └─ list
   └─ ip   
      ├─ create
      └─ info
```
