From 8905b88e72a92d801112908e3e06f06c437a3332 Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 29 Sep 2023 16:50:11 -0500 Subject: [PATCH 1/3] #2095 more doc improvements --- .readthedocs.yml | 10 ++- CONTRIBUTING.md | 15 ++++ SoftLayer/CLI/event_log/get.py | 3 +- SoftLayer/CLI/licenses/create_options.py | 2 +- SoftLayer/managers/license.py | 7 +- SoftLayer/managers/licenses.py | 25 ------ SoftLayer/managers/storage.py | 2 +- SoftLayer/managers/storage_utils.py | 2 +- SoftLayer/managers/tags.py | 28 ++++--- SoftLayer/managers/user.py | 48 ++++++----- docs/_templates/manager_template.rst | 35 ++++++++ docs/api/client.rst | 43 +++++++++- .../SoftLayer.managers.AccountManager.rst | 58 ++++++++++++++ .../SoftLayer.managers.BandwidthManager.rst | 39 +++++++++ ...SoftLayer.managers.BlockStorageManager.rst | 79 +++++++++++++++++++ .../SoftLayer.managers.CDNManager.rst | 47 +++++++++++ .../SoftLayer.managers.CapacityManager.rst | 40 ++++++++++ .../SoftLayer.managers.DNSManager.rst | 50 ++++++++++++ ...oftLayer.managers.DedicatedHostManager.rst | 43 ++++++++++ .../SoftLayer.managers.EventLogManager.rst | 30 +++++++ .../SoftLayer.managers.FileStorageManager.rst | 72 +++++++++++++++++ .../SoftLayer.managers.FirewallManager.rst | 47 +++++++++++ .../SoftLayer.managers.HardwareManager.rst | 66 ++++++++++++++++ .../SoftLayer.managers.IPSECManager.rst | 53 +++++++++++++ .../SoftLayer.managers.ImageManager.rst | 47 +++++++++++ .../SoftLayer.managers.LicensesManager.rst | 31 ++++++++ ...SoftLayer.managers.LoadBalancerManager.rst | 57 +++++++++++++ .../SoftLayer.managers.MetadataManager.rst | 36 +++++++++ .../SoftLayer.managers.NetworkManager.rst | 77 ++++++++++++++++++ ...oftLayer.managers.ObjectStorageManager.rst | 40 ++++++++++ .../SoftLayer.managers.OrderingManager.rst | 63 +++++++++++++++ .../SoftLayer.managers.PlacementManager.rst | 42 ++++++++++ .../SoftLayer.managers.SSLManager.rst | 32 ++++++++ .../SoftLayer.managers.SearchManager.rst | 32 ++++++++ .../SoftLayer.managers.SshKeyManager.rst | 39 +++++++++ .../SoftLayer.managers.TagManager.rst | 40 ++++++++++ .../SoftLayer.managers.TicketManager.rst | 44 +++++++++++ .../SoftLayer.managers.UserManager.rst | 69 ++++++++++++++++ .../managers/SoftLayer.managers.VSManager.rst | 68 ++++++++++++++++ docs/api/managers/account.rst | 5 -- docs/api/managers/block.rst | 5 -- docs/api/managers/cdn.rst | 5 -- docs/api/managers/dedicated_host.rst | 5 -- docs/api/managers/dns.rst | 5 -- docs/api/managers/email.rst | 5 -- docs/api/managers/event_log.rst | 5 -- docs/api/managers/file.rst | 5 -- docs/api/managers/firewall.rst | 5 -- docs/api/managers/hardware.rst | 5 -- docs/api/managers/image.rst | 5 -- docs/api/managers/ipsec.rst | 5 -- docs/api/managers/load_balancer.rst | 5 -- docs/api/managers/metadata.rst | 7 -- docs/api/managers/network.rst | 5 -- docs/api/managers/ordering.rst | 5 -- docs/api/managers/search.rst | 5 -- docs/api/managers/sshkey.rst | 5 -- docs/api/managers/ssl.rst | 5 -- docs/api/managers/ticket.rst | 5 -- docs/api/managers/vs.rst | 5 -- docs/api/managers/vs_capacity.rst | 5 -- docs/api/managers/vs_placement.rst | 5 -- docs/cli/email.rst | 2 +- docs/cli/event_log.rst | 2 +- docs/cli/hardware.rst | 4 +- docs/cli/ipsec.rst | 5 +- docs/cli/loadbal.rst | 2 +- docs/cli/tickets.rst | 3 +- docs/cli/users.rst | 2 +- docs/cli/vs.rst | 4 +- docs/conf.py | 35 +++++--- docs/config_file.rst | 2 +- docs/index.rst | 2 +- docs/install.rst | 11 --- docs/requirements.txt | 1 + 75 files changed, 1525 insertions(+), 228 deletions(-) delete mode 100644 SoftLayer/managers/licenses.py create mode 100644 docs/_templates/manager_template.rst create mode 100644 docs/api/managers/SoftLayer.managers.AccountManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.BandwidthManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.BlockStorageManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.CDNManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.CapacityManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.DNSManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.EventLogManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.FileStorageManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.FirewallManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.HardwareManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.IPSECManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.ImageManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.LicensesManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.MetadataManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.NetworkManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.OrderingManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.PlacementManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.SSLManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.SearchManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.SshKeyManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.TagManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.TicketManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.UserManager.rst create mode 100644 docs/api/managers/SoftLayer.managers.VSManager.rst delete mode 100644 docs/api/managers/account.rst delete mode 100644 docs/api/managers/block.rst delete mode 100644 docs/api/managers/cdn.rst delete mode 100644 docs/api/managers/dedicated_host.rst delete mode 100644 docs/api/managers/dns.rst delete mode 100644 docs/api/managers/email.rst delete mode 100644 docs/api/managers/event_log.rst delete mode 100644 docs/api/managers/file.rst delete mode 100644 docs/api/managers/firewall.rst delete mode 100644 docs/api/managers/hardware.rst delete mode 100644 docs/api/managers/image.rst delete mode 100644 docs/api/managers/ipsec.rst delete mode 100644 docs/api/managers/load_balancer.rst delete mode 100644 docs/api/managers/metadata.rst delete mode 100644 docs/api/managers/network.rst delete mode 100644 docs/api/managers/ordering.rst delete mode 100644 docs/api/managers/search.rst delete mode 100644 docs/api/managers/sshkey.rst delete mode 100644 docs/api/managers/ssl.rst delete mode 100644 docs/api/managers/ticket.rst delete mode 100644 docs/api/managers/vs.rst delete mode 100644 docs/api/managers/vs_capacity.rst delete mode 100644 docs/api/managers/vs_placement.rst diff --git a/.readthedocs.yml b/.readthedocs.yml index 73e4a4e5d..398267d4c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,6 +5,11 @@ # Required version: 2 +build: + os: ubuntu-23.04 + tools: + python: "3.10" + # Build documentation in the docs/ directory with Sphinx sphinx: builder: htmldir @@ -15,10 +20,11 @@ sphinx: # configuration: mkdocs.yml # Optionally build your docs in additional formats such as PDF and ePub -formats: all +# formats: all # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 + version: 3.11 install: - requirements: docs/requirements.txt + - method: pip diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12e88d2b1..fdcbb16f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,6 +49,21 @@ sphinx-build -b html -d _build/doctrees . _build/html ``` +### Note + +If you get this error, or similar... you might just need to remove the `_build/html/*` directory and try again, that seems to generally work. +``` +docs\cli\hardware.rst:15: ERROR: Failed to import "cli" from "SoftLayer.CLI.hardware.cancel". The following exception was raised: +Traceback (most recent call last): + File "py311\Lib\site-packages\sphinx_click\ext.py", line 403, in _load_module + mod = __import__(module_name, globals(), locals(), [attr_name]) + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + File "SoftLayer\CLI\hardware\cancel.py", line 13, in + @click.command(cls=SoftLayer.CLI.command.SLCommand, ) + ^^^^^^^^^^^^^^^^^^^^^ +AttributeError: module 'SoftLayer.CLI' has no attribute 'command' +``` + ## Unit Tests All new features should be 100% code covered, and your pull request should at the very least increase total code overage. diff --git a/SoftLayer/CLI/event_log/get.py b/SoftLayer/CLI/event_log/get.py index 92a481707..17a24f1d9 100644 --- a/SoftLayer/CLI/event_log/get.py +++ b/SoftLayer/CLI/event_log/get.py @@ -30,7 +30,8 @@ def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metadata, limit): """Get Event Logs - Example: + Example:: + slcli event-log get -d 01/01/2019 -D 02/01/2019 -t User -l 10 """ columns = ['Event', 'Object', 'Type', 'Date', 'Username'] diff --git a/SoftLayer/CLI/licenses/create_options.py b/SoftLayer/CLI/licenses/create_options.py index 00c7db3f9..91866e563 100644 --- a/SoftLayer/CLI/licenses/create_options.py +++ b/SoftLayer/CLI/licenses/create_options.py @@ -6,7 +6,7 @@ from SoftLayer.CLI.command import SLCommand as SLCommand from SoftLayer.CLI import environment from SoftLayer.CLI import formatting -from SoftLayer.managers.licenses import LicensesManager +from SoftLayer.managers.license import LicensesManager from SoftLayer import utils diff --git a/SoftLayer/managers/license.py b/SoftLayer/managers/license.py index 6048e35f7..df5ee9f0b 100644 --- a/SoftLayer/managers/license.py +++ b/SoftLayer/managers/license.py @@ -1,6 +1,6 @@ """ SoftLayer.license - ~~~~~~~~~~~~~~~ + ~~~~~~~~~~~~~~~~~ License Manager :license: MIT, see LICENSE for more details. @@ -11,6 +11,7 @@ from SoftLayer.managers import ordering from SoftLayer import utils +LICENSE_PACKAGE_ID = 301 class LicensesManager(object): """Manages account license.""" @@ -63,3 +64,7 @@ def create(self, datacenter, item_package): item_keynames=item_package, complex_type=complex_type, hourly=False) + + def get_create_options(self): + """Returns valid options for ordering Licenses.""" + return self.client.call('SoftLayer_Product_Package', 'getItems', id=LICENSE_PACKAGE_ID) \ No newline at end of file diff --git a/SoftLayer/managers/licenses.py b/SoftLayer/managers/licenses.py deleted file mode 100644 index 3f2dbb7c4..000000000 --- a/SoftLayer/managers/licenses.py +++ /dev/null @@ -1,25 +0,0 @@ -""" - SoftLayer.license - ~~~~~~~~~~~~~~~ - License Manager - :license: MIT, see LICENSE for more details. -""" - -# pylint: disable=too-many-public-methods - -LICENSE_PACKAGE_ID = 301 - - -class LicensesManager(object): - """Manages account lincese.""" - - def __init__(self, client): - self.client = client - - def get_create_options(self): - """Returns valid options for ordering Licenses. - - """ - - return self.client.call('SoftLayer_Product_Package', 'getItems', - id=LICENSE_PACKAGE_ID) diff --git a/SoftLayer/managers/storage.py b/SoftLayer/managers/storage.py index 28135e60f..48cda5a88 100644 --- a/SoftLayer/managers/storage.py +++ b/SoftLayer/managers/storage.py @@ -1,6 +1,6 @@ """ SoftLayer.storage - ~~~~~~~~~~~~~~~ + ~~~~~~~~~~~~~~~~~ Network Storage Manager :license: MIT, see LICENSE for more details. diff --git a/SoftLayer/managers/storage_utils.py b/SoftLayer/managers/storage_utils.py index cd2145e32..6c3e8343e 100644 --- a/SoftLayer/managers/storage_utils.py +++ b/SoftLayer/managers/storage_utils.py @@ -1,6 +1,6 @@ """ SoftLayer.storage_utils - ~~~~~~~~~~~~~~~ + ~~~~~~~~~~~~~~~~~~~~~~~ Utility functions used by File and Block Storage Managers :license: MIT, see LICENSE for more details. diff --git a/SoftLayer/managers/tags.py b/SoftLayer/managers/tags.py index 4886f3ec2..55ce72110 100644 --- a/SoftLayer/managers/tags.py +++ b/SoftLayer/managers/tags.py @@ -1,6 +1,6 @@ """ SoftLayer.tags - ~~~~~~~~~~~~ + ~~~~~~~~~~~~~~ Tag Manager :license: MIT, see LICENSE for more details. @@ -83,18 +83,20 @@ def reference_lookup(self, resource_table_id, tag_type): From SoftLayer_Tag::getAllTagTypes() - |Type |Service | - | ----------------------------- | ------ | - |Hardware |HARDWARE| - |CCI |GUEST| - |Account Document |ACCOUNT_DOCUMENT| - |Ticket |TICKET| - |Vlan Firewall |NETWORK_VLAN_FIREWALL| - |Contract |CONTRACT| - |Image Template |IMAGE_TEMPLATE| - |Application Delivery Controller |APPLICATION_DELIVERY_CONTROLLER| - |Vlan |NETWORK_VLAN| - |Dedicated Host |DEDICATED_HOST| + :: + + |Type |Service | + | ----------------------------- | ------ | + |Hardware |HARDWARE| + |CCI |GUEST| + |Account Document |ACCOUNT_DOCUMENT| + |Ticket |TICKET| + |Vlan Firewall |NETWORK_VLAN_FIREWALL| + |Contract |CONTRACT| + |Image Template |IMAGE_TEMPLATE| + |Application Delivery Controller |APPLICATION_DELIVERY_CONTROLLER| + |Vlan |NETWORK_VLAN| + |Dedicated Host |DEDICATED_HOST| """ service = self.type_to_service(tag_type) if service is None: diff --git a/SoftLayer/managers/user.py b/SoftLayer/managers/user.py index cafdf1b8f..8e854426c 100644 --- a/SoftLayer/managers/user.py +++ b/SoftLayer/managers/user.py @@ -101,6 +101,7 @@ def enable_notifications(self, notifications_names): :returns: True on success Example:: + enable_notifications(['Order Approved','Reload Complete']) """ @@ -120,6 +121,7 @@ def disable_notifications(self, notifications_names): :returns: True on success Example:: + disable_notifications(['Order Approved','Reload Complete']) """ @@ -140,6 +142,7 @@ def add_permissions(self, user_id, permissions): :returns: True on success, Exception otherwise Example:: + add_permissions(123, ['BANDWIDTH_MANAGE']) """ pretty_permissions = self.format_permission_object(permissions) @@ -154,6 +157,7 @@ def remove_permissions(self, user_id, permissions): :returns: True on success, Exception otherwise Example:: + remove_permissions(123, ['BANDWIDTH_MANAGE']) """ pretty_permissions = self.format_permission_object(permissions) @@ -196,7 +200,9 @@ def get_logins(self, user_id, start_date=None): :param int id: User id to get :param string start_date: "%m/%d/%Y %H:%M:%s" formatted string. :returns: list https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/ + Example:: + get_logins(123, '04/08/2018 0:0:0') """ @@ -366,7 +372,6 @@ def vpn_enable_or_disable(self, user_id, value): :param int user_id: User to edit. :param bool value: Value for vpn enable flag. - or :param bool value: Value for vpn disable flag. """ user_object = {'sslVpnAllowedFlag': value} @@ -426,9 +431,8 @@ def get_overrides_list(self, user_id, subnet_ids): def grant_hardware_access(self, user_id, hardware_id): """Grants the user access to a single hardware device. - :param int user_id: - :param int hardware_id - + :param int user_id: User Id + :param int hardware_id: Hardware Id :returns: true """ return self.user_service.addHardwareAccess(hardware_id, id=user_id) @@ -436,9 +440,8 @@ def grant_hardware_access(self, user_id, hardware_id): def grant_virtual_access(self, user_id, virtual_id): """Grants the user access to a single VS device. - :param int user_id: - :param int virtual_id - + :param int user_id: User Id + :param int virtual_id: Hardware Id :returns: true """ return self.user_service.addVirtualGuestAccess(virtual_id, id=user_id) @@ -446,9 +449,8 @@ def grant_virtual_access(self, user_id, virtual_id): def grant_dedicated_access(self, user_id, dedicated_id): """Grants the user access to a single dedicated host device. - :param int user_id: - :param int dedicated_id - + :param int user_id: User Id + :param int dedicated_id: Dedicatd Host Id :returns: true """ return self.user_service.addDedicatedHostAccess(dedicated_id, id=user_id) @@ -456,9 +458,8 @@ def grant_dedicated_access(self, user_id, dedicated_id): def remove_hardware_access(self, user_id, hardware_id): """Remove hardware from a portal user’s hardware access list. - :param int user_id: - :param int hardware_id - + :param int user_id: User Id + :param int hardware_id: Hardware Id :returns: true """ return self.user_service.removeHardwareAccess(hardware_id, id=user_id) @@ -466,9 +467,8 @@ def remove_hardware_access(self, user_id, hardware_id): def remove_virtual_access(self, user_id, virtual_id): """Remove hardware from a portal user’s virtual guests access list. - :param int user_id: - :param int hardware_id - + :param int user_id: User Id + :param int hardware_id: Hardware Id :returns: true """ return self.user_service.removeVirtualGuestAccess(virtual_id, id=user_id) @@ -476,9 +476,8 @@ def remove_virtual_access(self, user_id, virtual_id): def remove_dedicated_access(self, user_id, dedicated_id): """Remove hardware from a portal user’s dedicated host access list. - :param int user_id: - :param int dedicated_id - + :param int user_id: User Id + :param int dedicated_id: Dedicated Host Id :returns: true """ return self.user_service.removeDedicatedHostAccess(dedicated_id, id=user_id) @@ -486,7 +485,7 @@ def remove_dedicated_access(self, user_id, dedicated_id): def get_user_hardware(self, user_id): """User Hardware list. - :param int user_id: + :param int user_id: User Id :return: List hardware relate to user """ return self.user_service.getHardware(id=user_id) @@ -494,7 +493,7 @@ def get_user_hardware(self, user_id): def get_user_dedicated_host(self, user_id): """User dedicate host list. - :param int user_id: + :param int user_id: User Id :return: List dedicated host relate to user """ return self.user_service.getDedicatedHosts(id=user_id) @@ -502,7 +501,7 @@ def get_user_dedicated_host(self, user_id): def get_user_virtuals(self, user_id): """User virtual guest list. - :param int user_id: + :param int user_id: User Id :return: List virtual guest relate to user """ return self.user_service.getVirtualGuests(id=user_id) @@ -510,9 +509,8 @@ def get_user_virtuals(self, user_id): def update_vpn_password(self, user_id, password): """Update a user's VPN password. - :param int user_id: - :param string password: - + :param int user_id: User Id + :param string password: Password :returns: true """ return self.user_service.updateVpnPassword(password, id=user_id) diff --git a/docs/_templates/manager_template.rst b/docs/_templates/manager_template.rst new file mode 100644 index 000000000..f755ae5a2 --- /dev/null +++ b/docs/_templates/manager_template.rst @@ -0,0 +1,35 @@ +{{ objname }} +{{ underline }} + +{{name}} +{{fullname}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + :inherited-members: + + {% block methods %} + .. automethod:: __init__ + + {% if methods %} + .. rubric:: Methods + + .. autosummary:: + {% for item in methods %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block attributes %} + {% if attributes %} + .. rubric:: Attributes + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} \ No newline at end of file diff --git a/docs/api/client.rst b/docs/api/client.rst index 30bc071dd..75eddbde4 100644 --- a/docs/api/client.rst +++ b/docs/api/client.rst @@ -67,11 +67,46 @@ various services. These are higher-level interfaces to the SoftLayer API. **Available managers**: -.. toctree:: - :maxdepth: 1 - :glob: +.. currentmodule:: SoftLayer.managers + +.. autosummary:: + :toctree: managers + :recursive: + :template: manager_template.rst + + AccountManager + BandwidthManager + BlockStorageManager + CapacityManager + CDNManager + DedicatedHostManager + DNSManager + EventLogManager + FileStorageManager + FirewallManager + HardwareManager + ImageManager + IPSECManager + LicensesManager + LoadBalancerManager + MetadataManager + NetworkManager + ObjectStorageManager + OrderingManager + PlacementManager + SearchManager + SshKeyManager + SSLManager + TagManager + TicketManager + UserManager + VSManager + + + + + - managers/* If you need more power or functionality than the managers provide, you can make direct API calls as well. diff --git a/docs/api/managers/SoftLayer.managers.AccountManager.rst b/docs/api/managers/SoftLayer.managers.AccountManager.rst new file mode 100644 index 000000000..ffb3c79f6 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.AccountManager.rst @@ -0,0 +1,58 @@ +AccountManager +================================= + +AccountManager +SoftLayer.managers.AccountManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: AccountManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~AccountManager.__init__ + ~AccountManager.ack_event + ~AccountManager.add_event_filter + ~AccountManager.cancel_item + ~AccountManager.create_provisioning + ~AccountManager.delete_provisioning + ~AccountManager.getBandwidthDetail + ~AccountManager.get_account_all_billing_orders + ~AccountManager.get_account_billing_items + ~AccountManager.get_account_upgrade_orders + ~AccountManager.get_active_account_licenses + ~AccountManager.get_active_virtual_licenses + ~AccountManager.get_bandwidth_pool_counts + ~AccountManager.get_bandwidth_pools + ~AccountManager.get_billing_item + ~AccountManager.get_billing_item_from_invoice + ~AccountManager.get_billing_items + ~AccountManager.get_event + ~AccountManager.get_invoices + ~AccountManager.get_item_detail + ~AccountManager.get_network_message_delivery_accounts + ~AccountManager.get_provisioning_scripts + ~AccountManager.get_routers + ~AccountManager.get_summary + ~AccountManager.get_upcoming_events + ~AccountManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~AccountManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.BandwidthManager.rst b/docs/api/managers/SoftLayer.managers.BandwidthManager.rst new file mode 100644 index 000000000..e8a357f88 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.BandwidthManager.rst @@ -0,0 +1,39 @@ +BandwidthManager +=================================== + +BandwidthManager +SoftLayer.managers.BandwidthManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: BandwidthManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~BandwidthManager.__init__ + ~BandwidthManager.create_pool + ~BandwidthManager.delete_pool + ~BandwidthManager.edit_pool + ~BandwidthManager.get_bandwidth_detail + ~BandwidthManager.get_location_group + ~BandwidthManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~BandwidthManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst b/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst new file mode 100644 index 000000000..a7479c01b --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst @@ -0,0 +1,79 @@ +BlockStorageManager +====================================== + +BlockStorageManager +SoftLayer.managers.BlockStorageManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: BlockStorageManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~BlockStorageManager.__init__ + ~BlockStorageManager.assign_subnets_to_acl + ~BlockStorageManager.authorize_host_to_volume + ~BlockStorageManager.cancel_block_volume + ~BlockStorageManager.cancel_snapshot_space + ~BlockStorageManager.cancel_volume + ~BlockStorageManager.convert_dep_dupe + ~BlockStorageManager.convert_dupe_status + ~BlockStorageManager.create_or_update_lun_id + ~BlockStorageManager.create_snapshot + ~BlockStorageManager.deauthorize_host_to_volume + ~BlockStorageManager.delete_snapshot + ~BlockStorageManager.disable_snapshots + ~BlockStorageManager.disaster_recovery_failover_to_replicant + ~BlockStorageManager.enable_snapshots + ~BlockStorageManager.failback_from_replicant + ~BlockStorageManager.failover_to_replicant + ~BlockStorageManager.get_block_volume_access_list + ~BlockStorageManager.get_block_volume_details + ~BlockStorageManager.get_block_volume_snapshot_list + ~BlockStorageManager.get_buckets + ~BlockStorageManager.get_cloud_list + ~BlockStorageManager.get_end_points + ~BlockStorageManager.get_network_message_delivery_accounts + ~BlockStorageManager.get_replication_locations + ~BlockStorageManager.get_replication_partners + ~BlockStorageManager.get_subnets_in_acl + ~BlockStorageManager.get_volume_access_list + ~BlockStorageManager.get_volume_count_limits + ~BlockStorageManager.get_volume_details + ~BlockStorageManager.get_volume_snapshot_list + ~BlockStorageManager.get_volume_snapshot_notification_status + ~BlockStorageManager.list_block_volume_limit + ~BlockStorageManager.list_block_volumes + ~BlockStorageManager.list_volume_schedules + ~BlockStorageManager.order_block_volume + ~BlockStorageManager.order_duplicate_volume + ~BlockStorageManager.order_modified_volume + ~BlockStorageManager.order_replicant_volume + ~BlockStorageManager.order_snapshot_space + ~BlockStorageManager.refresh_dupe + ~BlockStorageManager.remove_subnets_from_acl + ~BlockStorageManager.resolve_ids + ~BlockStorageManager.restore_from_snapshot + ~BlockStorageManager.set_credential_password + ~BlockStorageManager.set_volume_snapshot_notification + ~BlockStorageManager.volume_set_note + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~BlockStorageManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.CDNManager.rst b/docs/api/managers/SoftLayer.managers.CDNManager.rst new file mode 100644 index 000000000..b4189e6bc --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.CDNManager.rst @@ -0,0 +1,47 @@ +CDNManager +============================= + +CDNManager +SoftLayer.managers.CDNManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: CDNManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~CDNManager.__init__ + ~CDNManager.add_origin + ~CDNManager.create_cdn + ~CDNManager.delete_cdn + ~CDNManager.edit + ~CDNManager.get_cache_key_query_rule + ~CDNManager.get_cdn + ~CDNManager.get_origins + ~CDNManager.get_usage_metrics + ~CDNManager.list_cdn + ~CDNManager.purge_content + ~CDNManager.remove_origin + ~CDNManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~CDNManager.end_date + ~CDNManager.resolvers + ~CDNManager.start_data + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.CapacityManager.rst b/docs/api/managers/SoftLayer.managers.CapacityManager.rst new file mode 100644 index 000000000..6f8fff52a --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.CapacityManager.rst @@ -0,0 +1,40 @@ +CapacityManager +================================== + +CapacityManager +SoftLayer.managers.CapacityManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: CapacityManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~CapacityManager.__init__ + ~CapacityManager.create + ~CapacityManager.create_guest + ~CapacityManager.get_available_routers + ~CapacityManager.get_create_options + ~CapacityManager.get_object + ~CapacityManager.list + ~CapacityManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~CapacityManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.DNSManager.rst b/docs/api/managers/SoftLayer.managers.DNSManager.rst new file mode 100644 index 000000000..f55719da2 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.DNSManager.rst @@ -0,0 +1,50 @@ +DNSManager +============================= + +DNSManager +SoftLayer.managers.DNSManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: DNSManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~DNSManager.__init__ + ~DNSManager.create_record + ~DNSManager.create_record_mx + ~DNSManager.create_record_ptr + ~DNSManager.create_record_srv + ~DNSManager.create_zone + ~DNSManager.delete_record + ~DNSManager.delete_zone + ~DNSManager.dump_zone + ~DNSManager.edit_record + ~DNSManager.edit_zone + ~DNSManager.get_record + ~DNSManager.get_records + ~DNSManager.get_zone + ~DNSManager.list_zones + ~DNSManager.resolve_ids + ~DNSManager.sync_host_record + ~DNSManager.sync_ptr_record + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DNSManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst b/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst new file mode 100644 index 000000000..4bb6770d9 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst @@ -0,0 +1,43 @@ +DedicatedHostManager +======================================= + +DedicatedHostManager +SoftLayer.managers.DedicatedHostManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: DedicatedHostManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~DedicatedHostManager.__init__ + ~DedicatedHostManager.cancel_guests + ~DedicatedHostManager.cancel_host + ~DedicatedHostManager.get_create_options + ~DedicatedHostManager.get_host + ~DedicatedHostManager.get_router_options + ~DedicatedHostManager.list_guests + ~DedicatedHostManager.list_instances + ~DedicatedHostManager.place_order + ~DedicatedHostManager.resolve_ids + ~DedicatedHostManager.verify_order + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DedicatedHostManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.EventLogManager.rst b/docs/api/managers/SoftLayer.managers.EventLogManager.rst new file mode 100644 index 000000000..1dfb97e93 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.EventLogManager.rst @@ -0,0 +1,30 @@ +EventLogManager +================================== + +EventLogManager +SoftLayer.managers.EventLogManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: EventLogManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~EventLogManager.__init__ + ~EventLogManager.build_filter + ~EventLogManager.get_event_log_types + ~EventLogManager.get_event_logs + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.FileStorageManager.rst b/docs/api/managers/SoftLayer.managers.FileStorageManager.rst new file mode 100644 index 000000000..5ff60182d --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.FileStorageManager.rst @@ -0,0 +1,72 @@ +FileStorageManager +===================================== + +FileStorageManager +SoftLayer.managers.FileStorageManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: FileStorageManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~FileStorageManager.__init__ + ~FileStorageManager.authorize_host_to_volume + ~FileStorageManager.cancel_file_volume + ~FileStorageManager.cancel_snapshot_space + ~FileStorageManager.cancel_volume + ~FileStorageManager.convert_dep_dupe + ~FileStorageManager.convert_dupe_status + ~FileStorageManager.create_snapshot + ~FileStorageManager.deauthorize_host_to_volume + ~FileStorageManager.delete_snapshot + ~FileStorageManager.disable_snapshots + ~FileStorageManager.disaster_recovery_failover_to_replicant + ~FileStorageManager.enable_snapshots + ~FileStorageManager.failback_from_replicant + ~FileStorageManager.failover_to_replicant + ~FileStorageManager.get_end_points + ~FileStorageManager.get_file_volume_access_list + ~FileStorageManager.get_file_volume_details + ~FileStorageManager.get_file_volume_snapshot_list + ~FileStorageManager.get_network_message_delivery_accounts + ~FileStorageManager.get_replication_locations + ~FileStorageManager.get_replication_partners + ~FileStorageManager.get_volume_access_list + ~FileStorageManager.get_volume_count_limits + ~FileStorageManager.get_volume_details + ~FileStorageManager.get_volume_snapshot_list + ~FileStorageManager.get_volume_snapshot_notification_status + ~FileStorageManager.list_file_volume_limit + ~FileStorageManager.list_file_volumes + ~FileStorageManager.list_volume_schedules + ~FileStorageManager.order_duplicate_volume + ~FileStorageManager.order_file_volume + ~FileStorageManager.order_modified_volume + ~FileStorageManager.order_replicant_volume + ~FileStorageManager.order_snapshot_space + ~FileStorageManager.refresh_dupe + ~FileStorageManager.resolve_ids + ~FileStorageManager.restore_from_snapshot + ~FileStorageManager.set_volume_snapshot_notification + ~FileStorageManager.volume_set_note + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~FileStorageManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.FirewallManager.rst b/docs/api/managers/SoftLayer.managers.FirewallManager.rst new file mode 100644 index 000000000..2234a02f1 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.FirewallManager.rst @@ -0,0 +1,47 @@ +FirewallManager +================================== + +FirewallManager +SoftLayer.managers.FirewallManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: FirewallManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~FirewallManager.__init__ + ~FirewallManager.add_standard_firewall + ~FirewallManager.add_vlan_firewall + ~FirewallManager.cancel_firewall + ~FirewallManager.edit_dedicated_fwl_rules + ~FirewallManager.edit_standard_fwl_rules + ~FirewallManager.get_dedicated_fwl_rules + ~FirewallManager.get_dedicated_package + ~FirewallManager.get_firewalls + ~FirewallManager.get_firewalls_gatewalls + ~FirewallManager.get_instance + ~FirewallManager.get_standard_fwl_rules + ~FirewallManager.get_standard_package + ~FirewallManager.get_summary + ~FirewallManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~FirewallManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.HardwareManager.rst b/docs/api/managers/SoftLayer.managers.HardwareManager.rst new file mode 100644 index 000000000..1251de70b --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.HardwareManager.rst @@ -0,0 +1,66 @@ +HardwareManager +================================== + +HardwareManager +SoftLayer.managers.HardwareManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: HardwareManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~HardwareManager.__init__ + ~HardwareManager.add_notification + ~HardwareManager.authorize_storage + ~HardwareManager.cancel_hardware + ~HardwareManager.change_port_speed + ~HardwareManager.create_credential + ~HardwareManager.edit + ~HardwareManager.get_bandwidth_allocation + ~HardwareManager.get_bandwidth_data + ~HardwareManager.get_cancellation_reasons + ~HardwareManager.get_components + ~HardwareManager.get_create_options + ~HardwareManager.get_hard_drives + ~HardwareManager.get_hardware + ~HardwareManager.get_hardware_item_prices + ~HardwareManager.get_instance + ~HardwareManager.get_maintenance_windows_detail + ~HardwareManager.get_notifications + ~HardwareManager.get_sensors + ~HardwareManager.get_software_components + ~HardwareManager.get_storage_credentials + ~HardwareManager.get_storage_details + ~HardwareManager.get_tracking_id + ~HardwareManager.list_hardware + ~HardwareManager.place_order + ~HardwareManager.reflash_firmware + ~HardwareManager.reload + ~HardwareManager.remove_notification + ~HardwareManager.rescue + ~HardwareManager.resolve_ids + ~HardwareManager.update_firmware + ~HardwareManager.upgrade + ~HardwareManager.verify_order + ~HardwareManager.wait_for_ready + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~HardwareManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.IPSECManager.rst b/docs/api/managers/SoftLayer.managers.IPSECManager.rst new file mode 100644 index 000000000..28d4d7d6a --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.IPSECManager.rst @@ -0,0 +1,53 @@ +IPSECManager +=============================== + +IPSECManager +SoftLayer.managers.IPSECManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: IPSECManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~IPSECManager.__init__ + ~IPSECManager.add_internal_subnet + ~IPSECManager.add_remote_subnet + ~IPSECManager.add_service_subnet + ~IPSECManager.apply_configuration + ~IPSECManager.cancel_item + ~IPSECManager.create_remote_subnet + ~IPSECManager.create_translation + ~IPSECManager.delete_remote_subnet + ~IPSECManager.get_translation + ~IPSECManager.get_translations + ~IPSECManager.get_tunnel_context + ~IPSECManager.get_tunnel_contexts + ~IPSECManager.order + ~IPSECManager.remove_internal_subnet + ~IPSECManager.remove_remote_subnet + ~IPSECManager.remove_service_subnet + ~IPSECManager.remove_translation + ~IPSECManager.resolve_ids + ~IPSECManager.update_translation + ~IPSECManager.update_tunnel_context + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~IPSECManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.ImageManager.rst b/docs/api/managers/SoftLayer.managers.ImageManager.rst new file mode 100644 index 000000000..c0925b393 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.ImageManager.rst @@ -0,0 +1,47 @@ +ImageManager +=============================== + +ImageManager +SoftLayer.managers.ImageManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: ImageManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~ImageManager.__init__ + ~ImageManager.add_locations + ~ImageManager.delete_image + ~ImageManager.deny_share_image + ~ImageManager.edit + ~ImageManager.export_image_to_uri + ~ImageManager.get_image + ~ImageManager.get_locations_list + ~ImageManager.get_storage_locations + ~ImageManager.import_image_from_uri + ~ImageManager.list_private_images + ~ImageManager.list_public_images + ~ImageManager.remove_locations + ~ImageManager.resolve_ids + ~ImageManager.share_image + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~ImageManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.LicensesManager.rst b/docs/api/managers/SoftLayer.managers.LicensesManager.rst new file mode 100644 index 000000000..a7d1f6afe --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.LicensesManager.rst @@ -0,0 +1,31 @@ +LicensesManager +================================== + +LicensesManager +SoftLayer.managers.LicensesManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: LicensesManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~LicensesManager.__init__ + ~LicensesManager.cancel_item + ~LicensesManager.create + ~LicensesManager.get_all_objects + ~LicensesManager.get_create_options + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst b/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst new file mode 100644 index 000000000..ef344db32 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst @@ -0,0 +1,57 @@ +LoadBalancerManager +====================================== + +LoadBalancerManager +SoftLayer.managers.LoadBalancerManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: LoadBalancerManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~LoadBalancerManager.__init__ + ~LoadBalancerManager.add_lb_l7_pool + ~LoadBalancerManager.add_lb_listener + ~LoadBalancerManager.add_lb_member + ~LoadBalancerManager.add_protocols + ~LoadBalancerManager.cancel_lbaas + ~LoadBalancerManager.del_lb_l7_pool + ~LoadBalancerManager.delete_lb_member + ~LoadBalancerManager.delete_protocol + ~LoadBalancerManager.get_adc + ~LoadBalancerManager.get_adcs + ~LoadBalancerManager.get_all_l7policies + ~LoadBalancerManager.get_l7policies + ~LoadBalancerManager.get_lb + ~LoadBalancerManager.get_lb_type + ~LoadBalancerManager.get_lb_uuid + ~LoadBalancerManager.get_lbaas + ~LoadBalancerManager.get_lbaas_by_name + ~LoadBalancerManager.get_lbaas_uuid_id + ~LoadBalancerManager.lbaas_order_options + ~LoadBalancerManager.order_lbaas + ~LoadBalancerManager.remove_lb_listener + ~LoadBalancerManager.resolve_ids + ~LoadBalancerManager.update_lb_health_monitors + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~LoadBalancerManager.TYPE + ~LoadBalancerManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.MetadataManager.rst b/docs/api/managers/SoftLayer.managers.MetadataManager.rst new file mode 100644 index 000000000..95b3f907a --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.MetadataManager.rst @@ -0,0 +1,36 @@ +MetadataManager +================================== + +MetadataManager +SoftLayer.managers.MetadataManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: MetadataManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~MetadataManager.__init__ + ~MetadataManager.get + ~MetadataManager.private_network + ~MetadataManager.public_network + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~MetadataManager.attribs + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.NetworkManager.rst b/docs/api/managers/SoftLayer.managers.NetworkManager.rst new file mode 100644 index 000000000..90d6f7156 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.NetworkManager.rst @@ -0,0 +1,77 @@ +NetworkManager +================================= + +NetworkManager +SoftLayer.managers.NetworkManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: NetworkManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~NetworkManager.__init__ + ~NetworkManager.add_global_ip + ~NetworkManager.add_securitygroup_rule + ~NetworkManager.add_securitygroup_rules + ~NetworkManager.add_subnet + ~NetworkManager.assign_global_ip + ~NetworkManager.attach_securitygroup_component + ~NetworkManager.attach_securitygroup_components + ~NetworkManager.cancel_global_ip + ~NetworkManager.cancel_item + ~NetworkManager.cancel_subnet + ~NetworkManager.clear_route + ~NetworkManager.create_securitygroup + ~NetworkManager.delete_securitygroup + ~NetworkManager.detach_securitygroup_component + ~NetworkManager.detach_securitygroup_components + ~NetworkManager.edit + ~NetworkManager.edit_note_subnet + ~NetworkManager.edit_securitygroup + ~NetworkManager.edit_securitygroup_rule + ~NetworkManager.get_cancel_failure_reasons + ~NetworkManager.get_closed_pods + ~NetworkManager.get_datacenter + ~NetworkManager.get_datacenter_by_keyname + ~NetworkManager.get_event_logs_by_request_id + ~NetworkManager.get_ip_by_address + ~NetworkManager.get_list_datacenter + ~NetworkManager.get_nas_credentials + ~NetworkManager.get_pods + ~NetworkManager.get_routers + ~NetworkManager.get_securitygroup + ~NetworkManager.get_subnet + ~NetworkManager.get_subnet_item_price + ~NetworkManager.get_vlan + ~NetworkManager.ip_lookup + ~NetworkManager.list_global_ips + ~NetworkManager.list_securitygroup_rules + ~NetworkManager.list_securitygroups + ~NetworkManager.list_subnets + ~NetworkManager.list_vlans + ~NetworkManager.remove_securitygroup_rule + ~NetworkManager.remove_securitygroup_rules + ~NetworkManager.resolve_global_ip_ids + ~NetworkManager.resolve_subnet_ids + ~NetworkManager.resolve_vlan_ids + ~NetworkManager.route + ~NetworkManager.set_subnet_ipddress_note + ~NetworkManager.set_tags + ~NetworkManager.set_tags_subnet + ~NetworkManager.summary_by_datacenter + ~NetworkManager.unassign_global_ip + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst b/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst new file mode 100644 index 000000000..84ae8dfb5 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst @@ -0,0 +1,40 @@ +ObjectStorageManager +======================================= + +ObjectStorageManager +SoftLayer.managers.ObjectStorageManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: ObjectStorageManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~ObjectStorageManager.__init__ + ~ObjectStorageManager.create_credential + ~ObjectStorageManager.delete_credential + ~ObjectStorageManager.limit_credential + ~ObjectStorageManager.list_accounts + ~ObjectStorageManager.list_credential + ~ObjectStorageManager.list_endpoints + ~ObjectStorageManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~ObjectStorageManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.OrderingManager.rst b/docs/api/managers/SoftLayer.managers.OrderingManager.rst new file mode 100644 index 000000000..4ae3c6559 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.OrderingManager.rst @@ -0,0 +1,63 @@ +OrderingManager +================================== + +OrderingManager +SoftLayer.managers.OrderingManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: OrderingManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~OrderingManager.__init__ + ~OrderingManager.delete_quote + ~OrderingManager.filter_outlet_packages + ~OrderingManager.generate_order + ~OrderingManager.generate_order_template + ~OrderingManager.get_all_cancelation + ~OrderingManager.get_item_capacity + ~OrderingManager.get_item_price_id + ~OrderingManager.get_item_prices + ~OrderingManager.get_item_prices_by_location + ~OrderingManager.get_items + ~OrderingManager.get_location_id + ~OrderingManager.get_only_active_packages + ~OrderingManager.get_order_container + ~OrderingManager.get_order_detail + ~OrderingManager.get_package_by_key + ~OrderingManager.get_package_by_type + ~OrderingManager.get_package_id_by_type + ~OrderingManager.get_packages_of_type + ~OrderingManager.get_preset_by_key + ~OrderingManager.get_preset_prices + ~OrderingManager.get_price_id_list + ~OrderingManager.get_quote_details + ~OrderingManager.get_quotes + ~OrderingManager.get_regions + ~OrderingManager.list_categories + ~OrderingManager.list_items + ~OrderingManager.list_packages + ~OrderingManager.list_presets + ~OrderingManager.order_quote + ~OrderingManager.package_locations + ~OrderingManager.place_order + ~OrderingManager.place_quote + ~OrderingManager.resolve_location_name + ~OrderingManager.save_quote + ~OrderingManager.verify_order + ~OrderingManager.verify_quote + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.PlacementManager.rst b/docs/api/managers/SoftLayer.managers.PlacementManager.rst new file mode 100644 index 000000000..42c0c0433 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.PlacementManager.rst @@ -0,0 +1,42 @@ +PlacementManager +=================================== + +PlacementManager +SoftLayer.managers.PlacementManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: PlacementManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~PlacementManager.__init__ + ~PlacementManager.create + ~PlacementManager.delete + ~PlacementManager.get_all_rules + ~PlacementManager.get_backend_router_id_from_hostname + ~PlacementManager.get_object + ~PlacementManager.get_routers + ~PlacementManager.get_rule_id_from_name + ~PlacementManager.list + ~PlacementManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~PlacementManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.SSLManager.rst b/docs/api/managers/SoftLayer.managers.SSLManager.rst new file mode 100644 index 000000000..6a011c917 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.SSLManager.rst @@ -0,0 +1,32 @@ +SSLManager +============================= + +SSLManager +SoftLayer.managers.SSLManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: SSLManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~SSLManager.__init__ + ~SSLManager.add_certificate + ~SSLManager.edit_certificate + ~SSLManager.get_certificate + ~SSLManager.list_certs + ~SSLManager.remove_certificate + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.SearchManager.rst b/docs/api/managers/SoftLayer.managers.SearchManager.rst new file mode 100644 index 000000000..6802d8904 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.SearchManager.rst @@ -0,0 +1,32 @@ +SearchManager +================================ + +SearchManager +SoftLayer.managers.SearchManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: SearchManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~SearchManager.__init__ + ~SearchManager.advanced + ~SearchManager.get_object_types + ~SearchManager.search + ~SearchManager.search_hadrware_instances + ~SearchManager.search_instances + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.SshKeyManager.rst b/docs/api/managers/SoftLayer.managers.SshKeyManager.rst new file mode 100644 index 000000000..3518975b5 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.SshKeyManager.rst @@ -0,0 +1,39 @@ +SshKeyManager +================================ + +SshKeyManager +SoftLayer.managers.SshKeyManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: SshKeyManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~SshKeyManager.__init__ + ~SshKeyManager.add_key + ~SshKeyManager.delete_key + ~SshKeyManager.edit_key + ~SshKeyManager.get_key + ~SshKeyManager.list_keys + ~SshKeyManager.resolve_ids + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~SshKeyManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.TagManager.rst b/docs/api/managers/SoftLayer.managers.TagManager.rst new file mode 100644 index 000000000..f9fd7c1f1 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.TagManager.rst @@ -0,0 +1,40 @@ +TagManager +============================= + +TagManager +SoftLayer.managers.TagManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: TagManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~TagManager.__init__ + ~TagManager.delete_tag + ~TagManager.get_all_tag_types + ~TagManager.get_attached_tags + ~TagManager.get_resource_name + ~TagManager.get_tag + ~TagManager.get_tag_by_name + ~TagManager.get_tag_references + ~TagManager.get_unattached_tags + ~TagManager.list_tags + ~TagManager.reference_lookup + ~TagManager.set_tags + ~TagManager.taggable_by_type + ~TagManager.type_to_service + + + + + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.TicketManager.rst b/docs/api/managers/SoftLayer.managers.TicketManager.rst new file mode 100644 index 000000000..4db7a04f3 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.TicketManager.rst @@ -0,0 +1,44 @@ +TicketManager +================================ + +TicketManager +SoftLayer.managers.TicketManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: TicketManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~TicketManager.__init__ + ~TicketManager.attach_hardware + ~TicketManager.attach_virtual_server + ~TicketManager.create_ticket + ~TicketManager.detach_hardware + ~TicketManager.detach_virtual_server + ~TicketManager.get_ticket + ~TicketManager.list_subjects + ~TicketManager.list_tickets + ~TicketManager.resolve_ids + ~TicketManager.update_ticket + ~TicketManager.upload_attachment + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~TicketManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.UserManager.rst b/docs/api/managers/SoftLayer.managers.UserManager.rst new file mode 100644 index 000000000..a67748f2d --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.UserManager.rst @@ -0,0 +1,69 @@ +UserManager +============================== + +UserManager +SoftLayer.managers.UserManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: UserManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~UserManager.__init__ + ~UserManager.add_api_authentication_key + ~UserManager.add_permissions + ~UserManager.create_user + ~UserManager.disable_notifications + ~UserManager.edit_user + ~UserManager.enable_notifications + ~UserManager.format_permission_object + ~UserManager.gather_notifications + ~UserManager.get_all_notifications + ~UserManager.get_all_permissions + ~UserManager.get_api_authentication_keys + ~UserManager.get_current_user + ~UserManager.get_events + ~UserManager.get_logins + ~UserManager.get_overrides_list + ~UserManager.get_user + ~UserManager.get_user_dedicated_host + ~UserManager.get_user_hardware + ~UserManager.get_user_permissions + ~UserManager.get_user_virtuals + ~UserManager.grant_dedicated_access + ~UserManager.grant_hardware_access + ~UserManager.grant_virtual_access + ~UserManager.list_users + ~UserManager.permissions_from_user + ~UserManager.remove_api_authentication_key + ~UserManager.remove_dedicated_access + ~UserManager.remove_hardware_access + ~UserManager.remove_permissions + ~UserManager.remove_virtual_access + ~UserManager.resolve_ids + ~UserManager.update_vpn_password + ~UserManager.vpn_enable_or_disable + ~UserManager.vpn_manual + ~UserManager.vpn_subnet_add + ~UserManager.vpn_subnet_remove + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~UserManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/SoftLayer.managers.VSManager.rst b/docs/api/managers/SoftLayer.managers.VSManager.rst new file mode 100644 index 000000000..564824ea1 --- /dev/null +++ b/docs/api/managers/SoftLayer.managers.VSManager.rst @@ -0,0 +1,68 @@ +VSManager +============================ + +VSManager +SoftLayer.managers.VSManager + +.. currentmodule:: SoftLayer.managers + +.. autoclass:: VSManager + :members: + :inherited-members: + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~VSManager.__init__ + ~VSManager.add_notification + ~VSManager.attach_portable_storage + ~VSManager.authorize_storage + ~VSManager.browser_access_log + ~VSManager.cancel_instance + ~VSManager.capture + ~VSManager.change_port_speed + ~VSManager.create_instance + ~VSManager.create_instances + ~VSManager.edit + ~VSManager.get_bandwidth_allocation + ~VSManager.get_bandwidth_data + ~VSManager.get_create_options + ~VSManager.get_disk_category_id_by_disk_number + ~VSManager.get_instance + ~VSManager.get_local_disks + ~VSManager.get_notifications + ~VSManager.get_portable_storage + ~VSManager.get_storage_credentials + ~VSManager.get_storage_details + ~VSManager.get_summary_data_usage + ~VSManager.get_tracking_id + ~VSManager.list_instances + ~VSManager.migrate + ~VSManager.migrate_dedicated + ~VSManager.order_guest + ~VSManager.reload_instance + ~VSManager.remove_notification + ~VSManager.rescue + ~VSManager.resolve_ids + ~VSManager.set_tags + ~VSManager.upgrade + ~VSManager.verify_create_instance + ~VSManager.wait_for_ready + ~VSManager.wait_for_transaction + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~VSManager.resolvers + + \ No newline at end of file diff --git a/docs/api/managers/account.rst b/docs/api/managers/account.rst deleted file mode 100644 index 25d76ed6a..000000000 --- a/docs/api/managers/account.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _account: - -.. automodule:: SoftLayer.managers.account - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/block.rst b/docs/api/managers/block.rst deleted file mode 100644 index dc0645219..000000000 --- a/docs/api/managers/block.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _block: - -.. automodule:: SoftLayer.managers.block - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/cdn.rst b/docs/api/managers/cdn.rst deleted file mode 100644 index 0d3b7996a..000000000 --- a/docs/api/managers/cdn.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _cdn: - -.. automodule:: SoftLayer.managers.cdn - :members: - :inherited-members: diff --git a/docs/api/managers/dedicated_host.rst b/docs/api/managers/dedicated_host.rst deleted file mode 100644 index a9f4f0815..000000000 --- a/docs/api/managers/dedicated_host.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _dedicated_host: - -.. automodule:: SoftLayer.managers.dedicated_host - :members: - :inherited-members: diff --git a/docs/api/managers/dns.rst b/docs/api/managers/dns.rst deleted file mode 100644 index 8d13ae657..000000000 --- a/docs/api/managers/dns.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _dns: - -.. automodule:: SoftLayer.managers.dns - :members: - :inherited-members: diff --git a/docs/api/managers/email.rst b/docs/api/managers/email.rst deleted file mode 100644 index 45d839c16..000000000 --- a/docs/api/managers/email.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _email: - -.. automodule:: SoftLayer.managers.email - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/event_log.rst b/docs/api/managers/event_log.rst deleted file mode 100644 index 41adfeaa4..000000000 --- a/docs/api/managers/event_log.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _event_log: - -.. automodule:: SoftLayer.managers.event_log - :members: - :inherited-members: diff --git a/docs/api/managers/file.rst b/docs/api/managers/file.rst deleted file mode 100644 index f27bdc3b4..000000000 --- a/docs/api/managers/file.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _file: - -.. automodule:: SoftLayer.managers.file - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/firewall.rst b/docs/api/managers/firewall.rst deleted file mode 100644 index c4f8767a2..000000000 --- a/docs/api/managers/firewall.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _firewall: - -.. automodule:: SoftLayer.managers.firewall - :members: - :inherited-members: diff --git a/docs/api/managers/hardware.rst b/docs/api/managers/hardware.rst deleted file mode 100644 index db0aa3210..000000000 --- a/docs/api/managers/hardware.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _hardware: - -.. automodule:: SoftLayer.managers.hardware - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/image.rst b/docs/api/managers/image.rst deleted file mode 100644 index 014d26436..000000000 --- a/docs/api/managers/image.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _image: - -.. automodule:: SoftLayer.managers.image - :members: - :inherited-members: diff --git a/docs/api/managers/ipsec.rst b/docs/api/managers/ipsec.rst deleted file mode 100644 index d3c326a7c..000000000 --- a/docs/api/managers/ipsec.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _ipsec: - -.. automodule:: SoftLayer.managers.ipsec - :members: - :inherited-members: diff --git a/docs/api/managers/load_balancer.rst b/docs/api/managers/load_balancer.rst deleted file mode 100644 index f97f0157f..000000000 --- a/docs/api/managers/load_balancer.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _load_balancer: - -.. automodule:: SoftLayer.managers.load_balancer - :members: - :inherited-members: diff --git a/docs/api/managers/metadata.rst b/docs/api/managers/metadata.rst deleted file mode 100644 index 2b88708d5..000000000 --- a/docs/api/managers/metadata.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _metadata: - -.. automodule:: SoftLayer.managers.metadata - :members: - :inherited-members: - -.. autoattribute:: SoftLayer.managers.metadata.METADATA_ATTRIBUTES \ No newline at end of file diff --git a/docs/api/managers/network.rst b/docs/api/managers/network.rst deleted file mode 100644 index 279509abf..000000000 --- a/docs/api/managers/network.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _network: - -.. automodule:: SoftLayer.managers.network - :members: - :inherited-members: diff --git a/docs/api/managers/ordering.rst b/docs/api/managers/ordering.rst deleted file mode 100644 index 442db4b2c..000000000 --- a/docs/api/managers/ordering.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _ordering: - -.. automodule:: SoftLayer.managers.ordering - :members: - :inherited-members: diff --git a/docs/api/managers/search.rst b/docs/api/managers/search.rst deleted file mode 100644 index 4016043bc..000000000 --- a/docs/api/managers/search.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _slsearch: - -.. automodule:: SoftLayer.managers.search - :members: - :inherited-members: \ No newline at end of file diff --git a/docs/api/managers/sshkey.rst b/docs/api/managers/sshkey.rst deleted file mode 100644 index aa157e840..000000000 --- a/docs/api/managers/sshkey.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _sshkey: - -.. automodule:: SoftLayer.managers.sshkey - :members: - :inherited-members: diff --git a/docs/api/managers/ssl.rst b/docs/api/managers/ssl.rst deleted file mode 100644 index b6d346824..000000000 --- a/docs/api/managers/ssl.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _ssl: - -.. automodule:: SoftLayer.managers.ssl - :members: - :inherited-members: diff --git a/docs/api/managers/ticket.rst b/docs/api/managers/ticket.rst deleted file mode 100644 index b8aedaf3f..000000000 --- a/docs/api/managers/ticket.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _ticket: - -.. automodule:: SoftLayer.managers.ticket - :members: - :inherited-members: diff --git a/docs/api/managers/vs.rst b/docs/api/managers/vs.rst deleted file mode 100644 index 88e17bde6..000000000 --- a/docs/api/managers/vs.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _vs: - -.. automodule:: SoftLayer.managers.vs - :members: - :inherited-members: diff --git a/docs/api/managers/vs_capacity.rst b/docs/api/managers/vs_capacity.rst deleted file mode 100644 index 3255a40b1..000000000 --- a/docs/api/managers/vs_capacity.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _vs_capacity: - -.. automodule:: SoftLayer.managers.vs_capacity - :members: - :inherited-members: diff --git a/docs/api/managers/vs_placement.rst b/docs/api/managers/vs_placement.rst deleted file mode 100644 index d5898f1f0..000000000 --- a/docs/api/managers/vs_placement.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _vs_placement: - -.. automodule:: SoftLayer.managers.vs_placement - :members: - :inherited-members: diff --git a/docs/cli/email.rst b/docs/cli/email.rst index 732d524d7..fbbbd745e 100644 --- a/docs/cli/email.rst +++ b/docs/cli/email.rst @@ -1,7 +1,7 @@ .. _cli_email: Email Commands -================= +============== .. click:: SoftLayer.CLI.email.list:cli diff --git a/docs/cli/event_log.rst b/docs/cli/event_log.rst index 47c7639e5..49903ad8c 100644 --- a/docs/cli/event_log.rst +++ b/docs/cli/event_log.rst @@ -1,7 +1,7 @@ .. _cli_event_log: Event-Log Commands -==================== +=================== .. click:: SoftLayer.CLI.event_log.get:cli diff --git a/docs/cli/hardware.rst b/docs/cli/hardware.rst index 490edaded..ce55f2cc9 100644 --- a/docs/cli/hardware.rst +++ b/docs/cli/hardware.rst @@ -1,7 +1,7 @@ .. _cli_hardware: -Interacting with Hardware -============================== +Hardware Commands +================= .. click:: SoftLayer.CLI.hardware.bandwidth:cli diff --git a/docs/cli/ipsec.rst b/docs/cli/ipsec.rst index 713905a33..cfd11022e 100644 --- a/docs/cli/ipsec.rst +++ b/docs/cli/ipsec.rst @@ -1,14 +1,13 @@ .. _cli_ipsec: -Interacting with IPSEC Tunnels -============================== +IPSEC Tunnels +============= The IPSEC :ref:`cli` commands can be used to configure an existing IPSEC tunnel context. Subnets in the SoftLayer private network can be associated to the tunnel context along with user-defined remote subnets. Address translation entries may also be defined to provide NAT functionality from static subnet IP addresses associated with the tunnel context to user-defined remote subnet IP addresses. .. note:: Most CLI actions that affect an IPSEC tunnel context do not result in configuration changes to SoftLayer network devices. A separate *configure* command is available to issue a device configuration request. -To see more information about the IPSEC tunnel context module and API internaction, see :doc:`IPSEC Module<../api/managers/ipsec>` documentation. .. _cli_ipsec_list: diff --git a/docs/cli/loadbal.rst b/docs/cli/loadbal.rst index 3ba20f9ee..7ccb7a15c 100644 --- a/docs/cli/loadbal.rst +++ b/docs/cli/loadbal.rst @@ -1,7 +1,7 @@ .. _cli_loadbalancer: LoadBalancers -=================================== +============= These commands were added in version `5.8.0 `_ LBaaS Commands diff --git a/docs/cli/tickets.rst b/docs/cli/tickets.rst index bb56aad86..cef4f4d75 100644 --- a/docs/cli/tickets.rst +++ b/docs/cli/tickets.rst @@ -1,8 +1,7 @@ .. _cli_tickets: Support Tickets -================= - +=============== The SoftLayer ticket API is used to create "classic" or Infrastructure Support cases. These tickets will still show up in your web portal, but for the more unified case management API, see the `Case Management API `_ .. note:: diff --git a/docs/cli/users.rst b/docs/cli/users.rst index af86b4a94..df8e4e826 100644 --- a/docs/cli/users.rst +++ b/docs/cli/users.rst @@ -1,7 +1,7 @@ .. _cli_user: Users -============= +===== Version 5.6.0 introduces the ability to interact with user accounts from the cli. .. click:: SoftLayer.CLI.user.list:cli diff --git a/docs/cli/vs.rst b/docs/cli/vs.rst index 58738f8da..bb7e6c2c5 100644 --- a/docs/cli/vs.rst +++ b/docs/cli/vs.rst @@ -1,7 +1,7 @@ .. _vs_user_docs: -Working with Virtual Servers -============================ +Virtual Servers +=============== Using the SoftLayer portal to order virtual servers is fine, but for a number of reasons it's often more convenient to use the command line. For this, you can use SoftLayer's command-line client to make administrative tasks quicker diff --git a/docs/conf.py b/docs/conf.py index 9e4c5205f..3a3634df1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,6 +14,7 @@ import sys import os +import datetime # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -28,10 +29,16 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.coverage', - 'sphinx.ext.viewcode', - 'sphinx_click.ext'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'sphinx_click.ext', + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.autosummary" +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,7 +56,8 @@ project = u'SoftLayer API Python Client' # Hack to avoid the "Redefining built-in 'copyright'" error from static # analysis tools -globals()['copyright'] = u'2019, SoftLayer Technologies, Inc.' +today_date = datetime.date.today() +copyright = f'{today_date.year}, SoftLayer Technologies, Inc.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -100,12 +108,15 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if on_rtd: - html_theme = 'default' -else: - html_theme = 'nature' - html_style = "style.css" +# on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +# if on_rtd: +# html_theme = 'default' +# else: +# html_theme = 'nature' +# html_style = "style.css" + +# html_theme = 'default' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -265,3 +276,5 @@ # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' + +autosummary_ignore_module_all = False diff --git a/docs/config_file.rst b/docs/config_file.rst index 57ecdc1d1..b7db2241d 100644 --- a/docs/config_file.rst +++ b/docs/config_file.rst @@ -8,7 +8,7 @@ locations. * Input directly into SoftLayer.create_client_from_env(...) * Enviorment variables (`SL_USERNAME`, `SL_API_KEY`) -* Config file locations (`~/.softlayer`, `/etc/softlayer.conf`) +* Config file locations (`~/.softlayer`, `/etc/softlayer.conf`, `%USERPROFILE%\AppData\Roaming\softlayer`) * Or argument (`-C/path/to/config` or `--config=/path/to/config`) The configuration file is INI-based and requires the `softlayer` section to be diff --git a/docs/index.rst b/docs/index.rst index 1d801d53d..3309bc1b6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ use SoftLayer's `XML-RPC interface Date: Fri, 29 Sep 2023 16:58:45 -0500 Subject: [PATCH 2/3] #2095 more doc improvements --- docs/_templates/manager_template.rst | 3 --- docs/api/managers/SoftLayer.managers.AccountManager.rst | 3 --- docs/api/managers/SoftLayer.managers.BandwidthManager.rst | 3 --- docs/api/managers/SoftLayer.managers.BlockStorageManager.rst | 3 --- docs/api/managers/SoftLayer.managers.CDNManager.rst | 3 --- docs/api/managers/SoftLayer.managers.CapacityManager.rst | 3 --- docs/api/managers/SoftLayer.managers.DNSManager.rst | 3 --- docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst | 3 --- docs/api/managers/SoftLayer.managers.EventLogManager.rst | 3 --- docs/api/managers/SoftLayer.managers.FileStorageManager.rst | 3 --- docs/api/managers/SoftLayer.managers.FirewallManager.rst | 3 --- docs/api/managers/SoftLayer.managers.HardwareManager.rst | 3 --- docs/api/managers/SoftLayer.managers.IPSECManager.rst | 3 --- docs/api/managers/SoftLayer.managers.ImageManager.rst | 3 --- docs/api/managers/SoftLayer.managers.LicensesManager.rst | 3 --- docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst | 3 --- docs/api/managers/SoftLayer.managers.MetadataManager.rst | 3 --- docs/api/managers/SoftLayer.managers.NetworkManager.rst | 3 --- docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst | 3 --- docs/api/managers/SoftLayer.managers.OrderingManager.rst | 3 --- docs/api/managers/SoftLayer.managers.PlacementManager.rst | 3 --- docs/api/managers/SoftLayer.managers.SSLManager.rst | 3 --- docs/api/managers/SoftLayer.managers.SearchManager.rst | 3 --- docs/api/managers/SoftLayer.managers.SshKeyManager.rst | 3 --- docs/api/managers/SoftLayer.managers.TagManager.rst | 3 --- docs/api/managers/SoftLayer.managers.TicketManager.rst | 3 --- docs/api/managers/SoftLayer.managers.UserManager.rst | 3 --- docs/api/managers/SoftLayer.managers.VSManager.rst | 3 --- docs/index.rst | 4 ++-- 29 files changed, 2 insertions(+), 86 deletions(-) diff --git a/docs/_templates/manager_template.rst b/docs/_templates/manager_template.rst index f755ae5a2..6cf823da4 100644 --- a/docs/_templates/manager_template.rst +++ b/docs/_templates/manager_template.rst @@ -1,9 +1,6 @@ {{ objname }} {{ underline }} -{{name}} -{{fullname}} - .. currentmodule:: {{ module }} .. autoclass:: {{ objname }} diff --git a/docs/api/managers/SoftLayer.managers.AccountManager.rst b/docs/api/managers/SoftLayer.managers.AccountManager.rst index ffb3c79f6..94f3daca6 100644 --- a/docs/api/managers/SoftLayer.managers.AccountManager.rst +++ b/docs/api/managers/SoftLayer.managers.AccountManager.rst @@ -1,9 +1,6 @@ AccountManager ================================= -AccountManager -SoftLayer.managers.AccountManager - .. currentmodule:: SoftLayer.managers .. autoclass:: AccountManager diff --git a/docs/api/managers/SoftLayer.managers.BandwidthManager.rst b/docs/api/managers/SoftLayer.managers.BandwidthManager.rst index e8a357f88..ade4e180b 100644 --- a/docs/api/managers/SoftLayer.managers.BandwidthManager.rst +++ b/docs/api/managers/SoftLayer.managers.BandwidthManager.rst @@ -1,9 +1,6 @@ BandwidthManager =================================== -BandwidthManager -SoftLayer.managers.BandwidthManager - .. currentmodule:: SoftLayer.managers .. autoclass:: BandwidthManager diff --git a/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst b/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst index a7479c01b..53cb35361 100644 --- a/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst +++ b/docs/api/managers/SoftLayer.managers.BlockStorageManager.rst @@ -1,9 +1,6 @@ BlockStorageManager ====================================== -BlockStorageManager -SoftLayer.managers.BlockStorageManager - .. currentmodule:: SoftLayer.managers .. autoclass:: BlockStorageManager diff --git a/docs/api/managers/SoftLayer.managers.CDNManager.rst b/docs/api/managers/SoftLayer.managers.CDNManager.rst index b4189e6bc..5e09a50f1 100644 --- a/docs/api/managers/SoftLayer.managers.CDNManager.rst +++ b/docs/api/managers/SoftLayer.managers.CDNManager.rst @@ -1,9 +1,6 @@ CDNManager ============================= -CDNManager -SoftLayer.managers.CDNManager - .. currentmodule:: SoftLayer.managers .. autoclass:: CDNManager diff --git a/docs/api/managers/SoftLayer.managers.CapacityManager.rst b/docs/api/managers/SoftLayer.managers.CapacityManager.rst index 6f8fff52a..a3eb06dc2 100644 --- a/docs/api/managers/SoftLayer.managers.CapacityManager.rst +++ b/docs/api/managers/SoftLayer.managers.CapacityManager.rst @@ -1,9 +1,6 @@ CapacityManager ================================== -CapacityManager -SoftLayer.managers.CapacityManager - .. currentmodule:: SoftLayer.managers .. autoclass:: CapacityManager diff --git a/docs/api/managers/SoftLayer.managers.DNSManager.rst b/docs/api/managers/SoftLayer.managers.DNSManager.rst index f55719da2..4232e879a 100644 --- a/docs/api/managers/SoftLayer.managers.DNSManager.rst +++ b/docs/api/managers/SoftLayer.managers.DNSManager.rst @@ -1,9 +1,6 @@ DNSManager ============================= -DNSManager -SoftLayer.managers.DNSManager - .. currentmodule:: SoftLayer.managers .. autoclass:: DNSManager diff --git a/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst b/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst index 4bb6770d9..8c9a9f407 100644 --- a/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst +++ b/docs/api/managers/SoftLayer.managers.DedicatedHostManager.rst @@ -1,9 +1,6 @@ DedicatedHostManager ======================================= -DedicatedHostManager -SoftLayer.managers.DedicatedHostManager - .. currentmodule:: SoftLayer.managers .. autoclass:: DedicatedHostManager diff --git a/docs/api/managers/SoftLayer.managers.EventLogManager.rst b/docs/api/managers/SoftLayer.managers.EventLogManager.rst index 1dfb97e93..d549daf3a 100644 --- a/docs/api/managers/SoftLayer.managers.EventLogManager.rst +++ b/docs/api/managers/SoftLayer.managers.EventLogManager.rst @@ -1,9 +1,6 @@ EventLogManager ================================== -EventLogManager -SoftLayer.managers.EventLogManager - .. currentmodule:: SoftLayer.managers .. autoclass:: EventLogManager diff --git a/docs/api/managers/SoftLayer.managers.FileStorageManager.rst b/docs/api/managers/SoftLayer.managers.FileStorageManager.rst index 5ff60182d..9b82d0c53 100644 --- a/docs/api/managers/SoftLayer.managers.FileStorageManager.rst +++ b/docs/api/managers/SoftLayer.managers.FileStorageManager.rst @@ -1,9 +1,6 @@ FileStorageManager ===================================== -FileStorageManager -SoftLayer.managers.FileStorageManager - .. currentmodule:: SoftLayer.managers .. autoclass:: FileStorageManager diff --git a/docs/api/managers/SoftLayer.managers.FirewallManager.rst b/docs/api/managers/SoftLayer.managers.FirewallManager.rst index 2234a02f1..f5886210d 100644 --- a/docs/api/managers/SoftLayer.managers.FirewallManager.rst +++ b/docs/api/managers/SoftLayer.managers.FirewallManager.rst @@ -1,9 +1,6 @@ FirewallManager ================================== -FirewallManager -SoftLayer.managers.FirewallManager - .. currentmodule:: SoftLayer.managers .. autoclass:: FirewallManager diff --git a/docs/api/managers/SoftLayer.managers.HardwareManager.rst b/docs/api/managers/SoftLayer.managers.HardwareManager.rst index 1251de70b..92f20d67a 100644 --- a/docs/api/managers/SoftLayer.managers.HardwareManager.rst +++ b/docs/api/managers/SoftLayer.managers.HardwareManager.rst @@ -1,9 +1,6 @@ HardwareManager ================================== -HardwareManager -SoftLayer.managers.HardwareManager - .. currentmodule:: SoftLayer.managers .. autoclass:: HardwareManager diff --git a/docs/api/managers/SoftLayer.managers.IPSECManager.rst b/docs/api/managers/SoftLayer.managers.IPSECManager.rst index 28d4d7d6a..d3f7c5768 100644 --- a/docs/api/managers/SoftLayer.managers.IPSECManager.rst +++ b/docs/api/managers/SoftLayer.managers.IPSECManager.rst @@ -1,9 +1,6 @@ IPSECManager =============================== -IPSECManager -SoftLayer.managers.IPSECManager - .. currentmodule:: SoftLayer.managers .. autoclass:: IPSECManager diff --git a/docs/api/managers/SoftLayer.managers.ImageManager.rst b/docs/api/managers/SoftLayer.managers.ImageManager.rst index c0925b393..9884d0e84 100644 --- a/docs/api/managers/SoftLayer.managers.ImageManager.rst +++ b/docs/api/managers/SoftLayer.managers.ImageManager.rst @@ -1,9 +1,6 @@ ImageManager =============================== -ImageManager -SoftLayer.managers.ImageManager - .. currentmodule:: SoftLayer.managers .. autoclass:: ImageManager diff --git a/docs/api/managers/SoftLayer.managers.LicensesManager.rst b/docs/api/managers/SoftLayer.managers.LicensesManager.rst index a7d1f6afe..8c062d307 100644 --- a/docs/api/managers/SoftLayer.managers.LicensesManager.rst +++ b/docs/api/managers/SoftLayer.managers.LicensesManager.rst @@ -1,9 +1,6 @@ LicensesManager ================================== -LicensesManager -SoftLayer.managers.LicensesManager - .. currentmodule:: SoftLayer.managers .. autoclass:: LicensesManager diff --git a/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst b/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst index ef344db32..06bf4047d 100644 --- a/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst +++ b/docs/api/managers/SoftLayer.managers.LoadBalancerManager.rst @@ -1,9 +1,6 @@ LoadBalancerManager ====================================== -LoadBalancerManager -SoftLayer.managers.LoadBalancerManager - .. currentmodule:: SoftLayer.managers .. autoclass:: LoadBalancerManager diff --git a/docs/api/managers/SoftLayer.managers.MetadataManager.rst b/docs/api/managers/SoftLayer.managers.MetadataManager.rst index 95b3f907a..bf6ae0dd2 100644 --- a/docs/api/managers/SoftLayer.managers.MetadataManager.rst +++ b/docs/api/managers/SoftLayer.managers.MetadataManager.rst @@ -1,9 +1,6 @@ MetadataManager ================================== -MetadataManager -SoftLayer.managers.MetadataManager - .. currentmodule:: SoftLayer.managers .. autoclass:: MetadataManager diff --git a/docs/api/managers/SoftLayer.managers.NetworkManager.rst b/docs/api/managers/SoftLayer.managers.NetworkManager.rst index 90d6f7156..66389d36a 100644 --- a/docs/api/managers/SoftLayer.managers.NetworkManager.rst +++ b/docs/api/managers/SoftLayer.managers.NetworkManager.rst @@ -1,9 +1,6 @@ NetworkManager ================================= -NetworkManager -SoftLayer.managers.NetworkManager - .. currentmodule:: SoftLayer.managers .. autoclass:: NetworkManager diff --git a/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst b/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst index 84ae8dfb5..88d44084c 100644 --- a/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst +++ b/docs/api/managers/SoftLayer.managers.ObjectStorageManager.rst @@ -1,9 +1,6 @@ ObjectStorageManager ======================================= -ObjectStorageManager -SoftLayer.managers.ObjectStorageManager - .. currentmodule:: SoftLayer.managers .. autoclass:: ObjectStorageManager diff --git a/docs/api/managers/SoftLayer.managers.OrderingManager.rst b/docs/api/managers/SoftLayer.managers.OrderingManager.rst index 4ae3c6559..179031c2c 100644 --- a/docs/api/managers/SoftLayer.managers.OrderingManager.rst +++ b/docs/api/managers/SoftLayer.managers.OrderingManager.rst @@ -1,9 +1,6 @@ OrderingManager ================================== -OrderingManager -SoftLayer.managers.OrderingManager - .. currentmodule:: SoftLayer.managers .. autoclass:: OrderingManager diff --git a/docs/api/managers/SoftLayer.managers.PlacementManager.rst b/docs/api/managers/SoftLayer.managers.PlacementManager.rst index 42c0c0433..829152eab 100644 --- a/docs/api/managers/SoftLayer.managers.PlacementManager.rst +++ b/docs/api/managers/SoftLayer.managers.PlacementManager.rst @@ -1,9 +1,6 @@ PlacementManager =================================== -PlacementManager -SoftLayer.managers.PlacementManager - .. currentmodule:: SoftLayer.managers .. autoclass:: PlacementManager diff --git a/docs/api/managers/SoftLayer.managers.SSLManager.rst b/docs/api/managers/SoftLayer.managers.SSLManager.rst index 6a011c917..0501588a3 100644 --- a/docs/api/managers/SoftLayer.managers.SSLManager.rst +++ b/docs/api/managers/SoftLayer.managers.SSLManager.rst @@ -1,9 +1,6 @@ SSLManager ============================= -SSLManager -SoftLayer.managers.SSLManager - .. currentmodule:: SoftLayer.managers .. autoclass:: SSLManager diff --git a/docs/api/managers/SoftLayer.managers.SearchManager.rst b/docs/api/managers/SoftLayer.managers.SearchManager.rst index 6802d8904..571d9368a 100644 --- a/docs/api/managers/SoftLayer.managers.SearchManager.rst +++ b/docs/api/managers/SoftLayer.managers.SearchManager.rst @@ -1,9 +1,6 @@ SearchManager ================================ -SearchManager -SoftLayer.managers.SearchManager - .. currentmodule:: SoftLayer.managers .. autoclass:: SearchManager diff --git a/docs/api/managers/SoftLayer.managers.SshKeyManager.rst b/docs/api/managers/SoftLayer.managers.SshKeyManager.rst index 3518975b5..cfd3d99b2 100644 --- a/docs/api/managers/SoftLayer.managers.SshKeyManager.rst +++ b/docs/api/managers/SoftLayer.managers.SshKeyManager.rst @@ -1,9 +1,6 @@ SshKeyManager ================================ -SshKeyManager -SoftLayer.managers.SshKeyManager - .. currentmodule:: SoftLayer.managers .. autoclass:: SshKeyManager diff --git a/docs/api/managers/SoftLayer.managers.TagManager.rst b/docs/api/managers/SoftLayer.managers.TagManager.rst index f9fd7c1f1..f3ab04e0f 100644 --- a/docs/api/managers/SoftLayer.managers.TagManager.rst +++ b/docs/api/managers/SoftLayer.managers.TagManager.rst @@ -1,9 +1,6 @@ TagManager ============================= -TagManager -SoftLayer.managers.TagManager - .. currentmodule:: SoftLayer.managers .. autoclass:: TagManager diff --git a/docs/api/managers/SoftLayer.managers.TicketManager.rst b/docs/api/managers/SoftLayer.managers.TicketManager.rst index 4db7a04f3..e257263df 100644 --- a/docs/api/managers/SoftLayer.managers.TicketManager.rst +++ b/docs/api/managers/SoftLayer.managers.TicketManager.rst @@ -1,9 +1,6 @@ TicketManager ================================ -TicketManager -SoftLayer.managers.TicketManager - .. currentmodule:: SoftLayer.managers .. autoclass:: TicketManager diff --git a/docs/api/managers/SoftLayer.managers.UserManager.rst b/docs/api/managers/SoftLayer.managers.UserManager.rst index a67748f2d..a161f7103 100644 --- a/docs/api/managers/SoftLayer.managers.UserManager.rst +++ b/docs/api/managers/SoftLayer.managers.UserManager.rst @@ -1,9 +1,6 @@ UserManager ============================== -UserManager -SoftLayer.managers.UserManager - .. currentmodule:: SoftLayer.managers .. autoclass:: UserManager diff --git a/docs/api/managers/SoftLayer.managers.VSManager.rst b/docs/api/managers/SoftLayer.managers.VSManager.rst index 564824ea1..073627c9a 100644 --- a/docs/api/managers/SoftLayer.managers.VSManager.rst +++ b/docs/api/managers/SoftLayer.managers.VSManager.rst @@ -1,9 +1,6 @@ VSManager ============================ -VSManager -SoftLayer.managers.VSManager - .. currentmodule:: SoftLayer.managers .. autoclass:: VSManager diff --git a/docs/index.rst b/docs/index.rst index 3309bc1b6..e0c8ebf19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,8 +10,8 @@ SoftLayer API Python Client |version| This is the documentation to SoftLayer's Python API Bindings. These bindings -use SoftLayer's `XML-RPC interface `_ -in order to manage SoftLayer services. +use SoftLayer's `XML-RPC interface `_ +in order to manage SoftLayer services. Also support REST. .. toctree:: :maxdepth: 1 From 98d1ec667fc8fc89260edecf5072dcc4d544f53c Mon Sep 17 00:00:00 2001 From: Christopher Gallo Date: Fri, 29 Sep 2023 17:08:22 -0500 Subject: [PATCH 3/3] Tox fixes --- SoftLayer/CLI/event_log/get.py | 2 +- SoftLayer/managers/license.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/SoftLayer/CLI/event_log/get.py b/SoftLayer/CLI/event_log/get.py index 17a24f1d9..0a7ca5936 100644 --- a/SoftLayer/CLI/event_log/get.py +++ b/SoftLayer/CLI/event_log/get.py @@ -31,7 +31,7 @@ def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metada """Get Event Logs Example:: - + slcli event-log get -d 01/01/2019 -D 02/01/2019 -t User -l 10 """ columns = ['Event', 'Object', 'Type', 'Date', 'Username'] diff --git a/SoftLayer/managers/license.py b/SoftLayer/managers/license.py index df5ee9f0b..6a0d01cd1 100644 --- a/SoftLayer/managers/license.py +++ b/SoftLayer/managers/license.py @@ -13,6 +13,7 @@ LICENSE_PACKAGE_ID = 301 + class LicensesManager(object): """Manages account license.""" @@ -67,4 +68,4 @@ def create(self, datacenter, item_package): def get_create_options(self): """Returns valid options for ordering Licenses.""" - return self.client.call('SoftLayer_Product_Package', 'getItems', id=LICENSE_PACKAGE_ID) \ No newline at end of file + return self.client.call('SoftLayer_Product_Package', 'getItems', id=LICENSE_PACKAGE_ID)