You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This library is provided `as is` to make internal IMS API calls. You are responsible for your API usage, and any abuse, intentional or accidental, will result in your employee account being locked or limited.
Another (safer) method of installation is to use the published snap. Snaps are available for any Linux OS running snapd, the service that runs and manage snaps. Snaps are "auto-updating" packages and will not disrupt the current versions of libraries and software packages on your Linux-based system. To learn more, please visit: https://snapcraft.io/
30
+
The config file is located at `~/.softlayer` or `~/AppData/Roaming/softlayer` for Windows systems.
58
31
59
-
To install the slcli snap:
32
+
Your config file should look something like this for using the islcli. Beware the `islcli` and `slcli` use the same config for the moment. You need to set `verify = False` in the config because the internal endpoint uses a self-signed SSL certificate.
The most up-to-date version of this library can be found on the SoftLayer
73
-
GitHub public repositories at http://github.com/softlayer. For questions regarding the use of this library please post to Stack Overflow at https://stackoverflow.com/ and your posts with “SoftLayer” so our team can easily find your post. To report a bug with this library please create an Issue on github.
74
-
75
-
InsecurePlatformWarning Notice
76
-
------------------------------
77
-
This library relies on the `requests <http://docs.python-requests.org/>`_ library to make HTTP requests. On Python versions below Python 2.7.9, requests has started emitting a security warning (InsecurePlatformWarning) due to insecurities with creating SSL connections. To resolve this, upgrade to Python 2.7.9+ or follow the instructions here: http://stackoverflow.com/a/29099439.
@@ -90,26 +58,40 @@ You can automatically set some parameters via environment variables with by usin
90
58
91
59
$ export SLCLI_VERBOSE=3
92
60
$ export SLCLI_FORMAT=json
93
-
$ slcli vs list
61
+
$ slcli -a <account_id>vs list
94
62
95
63
is equivalent to
96
64
97
65
.. code-block:: bash
98
66
99
-
$ slcli -vvv --format=json vs list
67
+
$ slcli -vvv --format=json -a <account_id>vs list
100
68
101
69
Getting Help
102
70
------------
103
-
Bugs and feature requests about this library should have a `GitHub issue <https://github.com/softlayer/softlayer-python/issues>`_ opened about them.
104
71
105
-
Issues with the Softlayer API itself should be addressed by opening a ticket.
72
+
Feel free to open an issue if you think there is a bug, or a feature you want. Or asking in #sl-api on IBM slack. This is considered an unofficial project however, so questions might take some time to get answered.
106
73
107
74
108
75
Examples
109
76
--------
110
77
111
78
A curated list of examples on how to use this library can be found at `SLDN <https://softlayer.github.io/python/>`_
result = client.call('SoftLayer_Account', 'getObject', id="12345", mask="mask[id]")
90
+
91
+
92
+
After logging in with `authenticate_with_password` the EmployeeClient will try to automatically refresh the login token when it gets a TokenExpired exception. It will also record the token in the config file for future use in the CLI.
93
+
94
+
113
95
Debugging
114
96
---------
115
97
To get the exact API call that this library makes, you can do the following.
@@ -131,7 +113,7 @@ If you are using the library directly in python, you can do something like this.
@@ -153,16 +135,13 @@ If you are using the library directly in python, you can do something like this.
153
135
154
136
System Requirements
155
137
-------------------
156
-
* Python 3.5, 3.6, 3.7, 3.8, or 3.9.
157
-
* A valid SoftLayer API username and key.
158
-
* A connection to SoftLayer's private network is required to use
159
-
our private network API endpoints.
138
+
* Python 3.7, 3.8, or 3.9.
139
+
* A valid SoftLayer Employee API username, password, Yubi Key
140
+
* A connection to SoftLayer's Employee VPN
160
141
161
142
Python 2.7 Support
162
143
------------------
163
-
As of version 5.8.0 SoftLayer-Python will no longer support python2.7, which is `End Of Life as of 2020 <https://www.python.org/dev/peps/pep-0373/>`_ .
164
-
If you cannot install python 3.6+ for some reason, you will need to use a version of softlayer-python <= 5.7.2
165
-
144
+
Python 2.7 is `End Of Life as of 2020 <https://www.python.org/dev/peps/pep-0373/>`_ . Its not supported, you will need to upgrade to python 3.7 at least.
0 commit comments