From de4978740d9bee8bab0f0ffaa1ac6ea5c86126e0 Mon Sep 17 00:00:00 2001 From: Tim Hatch Date: Fri, 5 Jul 2019 10:35:11 -0700 Subject: [PATCH] Fix some invalid escape sequences by switching to raw. This is new as of 3.6 per https://docs.python.org/3/whatsnew/3.6.html#deprecated-python-behavior --- purestorage/purestorage.py | 190 ++++++++++++++++++------------------- 1 file changed, 95 insertions(+), 95 deletions(-) diff --git a/purestorage/purestorage.py b/purestorage/purestorage.py index 5a06d66..bdd4b28 100644 --- a/purestorage/purestorage.py +++ b/purestorage/purestorage.py @@ -1,4 +1,4 @@ -""" +r""" This library provides an easy way to script administration tasks for the Pure Storage FlashArray. @@ -290,7 +290,7 @@ def disable_console_lock(self): return self._set_console_lock(enabled=False) def get(self, **kwargs): - """Get array attributes. + r"""Get array attributes. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -328,7 +328,7 @@ def rename(self, name): return self.set(name=name) def set(self, **kwargs): - """Set array attributes. + r"""Set array attributes. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -347,7 +347,7 @@ def set(self, **kwargs): # def set_volume(self, volume, **kwargs): - """Perform actions on a volume and return a dictionary describing it. + r"""Perform actions on a volume and return a dictionary describing it. :param volume: Name of the volume to be modified. :type volume: str @@ -363,7 +363,7 @@ def set_volume(self, volume, **kwargs): return self._request("PUT", "volume/{0}".format(volume), kwargs) def create_snapshot(self, volume, **kwargs): - """Create a snapshot of the given volume. + r"""Create a snapshot of the given volume. :param volume: Name of the volume of which to take a snapshot. :type volume: str @@ -379,7 +379,7 @@ def create_snapshot(self, volume, **kwargs): return self.create_snapshots([volume], **kwargs)[0] def create_snapshots(self, volumes, **kwargs): - """Create snapshots of the listed volumes. + r"""Create snapshots of the listed volumes. :param volumes: List of names of the volumes to snapshot. :type volumes: list of str @@ -397,7 +397,7 @@ def create_snapshots(self, volumes, **kwargs): return self._request("POST", "volume", data) def create_volume(self, volume, size, **kwargs): - """Create a volume and return a dictionary describing it. + r"""Create a volume and return a dictionary describing it. :param volume: Name of the volume to be created. :type volume: str @@ -467,7 +467,7 @@ def create_conglomerate_volume(self, volume): return self._request("POST", "volume/{0}".format(volume), {"protocol_endpoint": True}) def copy_volume(self, source, dest, **kwargs): - """Clone a volume and return a dictionary describing the new volume. + r"""Clone a volume and return a dictionary describing the new volume. :param source: Name of the source volume. :type source: str @@ -573,7 +573,7 @@ def extend_volume(self, volume, size): return self.set_volume(volume, size=size, truncate=False) def get_volume(self, volume, **kwargs): - """Return a dictionary describing a volume or snapshot. + r"""Return a dictionary describing a volume or snapshot. :param volume: Name of the volume to get information about. :type volume: str @@ -629,7 +629,7 @@ def remove_volume(self, volume, pgroup): return self._request("DELETE", "volume/{0}/pgroup/{1}".format(volume, pgroup)) def list_volume_block_differences(self, volume, **kwargs): - """Return a list of block differences for the specified volume. + r"""Return a list of block differences for the specified volume. :param volume: Name of the volume to get information about. :type volume: str @@ -674,7 +674,7 @@ def list_volume_shared_connections(self, volume, **kwargs): return self._request("GET", "volume/{0}/hgroup".format(volume), kwargs) def list_volumes(self, **kwargs): - """Return a list of dictionaries describing each volume. + r"""Return a list of dictionaries describing each volume. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -774,7 +774,7 @@ def move_volume(self, volume, container): # def connect_host(self, host, volume, **kwargs): - """Create a connection between a host and a volume. + r"""Create a connection between a host and a volume. :param host: Name of host to connect to volume. :type host: str @@ -793,7 +793,7 @@ def connect_host(self, host, volume, **kwargs): "POST", "host/{0}/volume/{1}".format(host, volume), kwargs) def create_host(self, host, **kwargs): - """Create a host are return a dictionary describing it. + r"""Create a host are return a dictionary describing it. :param host: Name of host to be created. :type host: str @@ -836,7 +836,7 @@ def disconnect_host(self, host, volume): volume)) def get_host(self, host, **kwargs): - """Return a dictionary describing a host. + r"""Return a dictionary describing a host. :param host: Name of host to get information about. :type host: str @@ -886,7 +886,7 @@ def remove_host(self, host, pgroup): return self._request("DELETE", "host/{0}/pgroup/{1}".format(host, pgroup)) def list_host_connections(self, host, **kwargs): - """Return a list of dictionaries describing connected volumes. + r"""Return a list of dictionaries describing connected volumes. :type host: str Name of host for which to list connections. @@ -902,7 +902,7 @@ def list_host_connections(self, host, **kwargs): return self._request("GET", "host/{0}/volume".format(host), kwargs) def list_hosts(self, **kwargs): - """Return a list of dictionaries describing each host. + r"""Return a list of dictionaries describing each host. :type \*\*kwargs: optional :param \*\*kwargs: See the REST API Guide on your array for the @@ -930,7 +930,7 @@ def rename_host(self, host, name): return self.set_host(host, name=name) def set_host(self, host, **kwargs): - """Set an attribute of a host. + r"""Set an attribute of a host. :param host: Name of host for which to set attribute. :type host: str @@ -950,7 +950,7 @@ def set_host(self, host, **kwargs): # def connect_hgroup(self, hgroup, volume, **kwargs): - """Create a shared connection between a host group and a volume. + r"""Create a shared connection between a host group and a volume. :param hgroup: Name of hgroup to connect to volume. :type hgroup: str @@ -969,7 +969,7 @@ def connect_hgroup(self, hgroup, volume, **kwargs): "POST", "hgroup/{0}/volume/{1}".format(hgroup, volume), kwargs) def create_hgroup(self, hgroup, **kwargs): - """Create a host group and return a dictionary describing it. + r"""Create a host group and return a dictionary describing it. :param hgroup: Name of hgroup to be created. :type hgroup: str @@ -1012,7 +1012,7 @@ def disconnect_hgroup(self, hgroup, volume): "hgroup/{0}/volume/{1}".format(hgroup, volume)) def get_hgroup(self, hgroup, **kwargs): - """Return a list of dictionaries describing a host group. + r"""Return a list of dictionaries describing a host group. :param hgroup: Name of hgroup to get information about. :type hgroup: str @@ -1074,7 +1074,7 @@ def list_hgroup_connections(self, hgroup): return self._request("GET", "hgroup/{0}/volume".format(hgroup)) def list_hgroups(self, **kwargs): - """Return a list of dictionaries describing each host group. + r"""Return a list of dictionaries describing each host group. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1102,7 +1102,7 @@ def rename_hgroup(self, hgroup, name): return self.set_hgroup(hgroup, name=name) def set_hgroup(self, hgroup, **kwargs): - """Set an attribute of a host group. + r"""Set an attribute of a host group. :param hgroup: Name of hgroup for which to set attribute. :type hgroup: str @@ -1122,7 +1122,7 @@ def set_hgroup(self, hgroup, **kwargs): # def connect_nfs_offload(self, name, **kwargs): - """Connect an offload nfs target. + r"""Connect an offload nfs target. :param name: Name of offload nfs target to be connected. :type name: str @@ -1138,7 +1138,7 @@ def connect_nfs_offload(self, name, **kwargs): return self._request("POST", "nfs_offload/{0}".format(name), kwargs) def connect_s3_offload(self, name, **kwargs): - """Connect an offload S3 target. + r"""Connect an offload S3 target. :param name: Name of offload S3 target to be connected. :type name: str @@ -1178,7 +1178,7 @@ def disconnect_s3_offload(self, name): return self._request("DELETE", "s3_offload/{0}".format(name)) def list_offload(self, **kwargs): - """Return a list of dictionaries describing connected offload targets. + r"""Return a list of dictionaries describing connected offload targets. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1192,7 +1192,7 @@ def list_offload(self, **kwargs): return self._request("GET", "offload", kwargs) def list_nfs_offload(self, **kwargs): - """Return a list of dictionaries describing connected nfs offload targets. + r"""Return a list of dictionaries describing connected nfs offload targets. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1206,7 +1206,7 @@ def list_nfs_offload(self, **kwargs): return self._request("GET", "nfs_offload", kwargs) def list_s3_offload(self, **kwargs): - """Return a list of dictionaries describing connected S3 offload targets. + r"""Return a list of dictionaries describing connected S3 offload targets. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1220,7 +1220,7 @@ def list_s3_offload(self, **kwargs): return self._request("GET", "s3_offload", kwargs) def get_offload(self, name, **kwargs): - """Return a dictionary describing the connected offload target. + r"""Return a dictionary describing the connected offload target. :param offload: Name of offload target to get information about. :type offload: str @@ -1242,7 +1242,7 @@ def get_offload(self, name, **kwargs): return result def get_nfs_offload(self, name, **kwargs): - """Return a dictionary describing the connected nfs offload target. + r"""Return a dictionary describing the connected nfs offload target. :param offload: Name of NFS offload target to get information about. :type offload: str @@ -1264,7 +1264,7 @@ def get_nfs_offload(self, name, **kwargs): return result def get_s3_offload(self, name, **kwargs): - """Return a dictionary describing the connected S3 offload target. + r"""Return a dictionary describing the connected S3 offload target. :param offload: Name of S3 offload target to get information about. :type offload: str @@ -1329,7 +1329,7 @@ def list_network_interfaces(self): return self._request("GET", "network") def set_network_interface(self, interface, **kwargs): - """Set network interface attributes. + r"""Set network interface attributes. :param interface: Name of network interface for which to set attribute. :type interface: str @@ -1345,7 +1345,7 @@ def set_network_interface(self, interface, **kwargs): return self._request("PUT", "network/{0}".format(interface), kwargs) def create_subnet(self, subnet, prefix, **kwargs): - """Create a subnet. + r"""Create a subnet. :param subnet: Name of subnet to be created. :type subnet: str @@ -1438,7 +1438,7 @@ def get_subnet(self, subnet): return self._request("GET", "subnet/{0}".format(subnet)) def list_subnets(self, **kwargs): - """Get a list of dictionaries describing subnets. + r"""Get a list of dictionaries describing subnets. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1474,7 +1474,7 @@ def rename_subnet(self, subnet, name): return self.set_subnet(subnet, name=name) def set_subnet(self, subnet, **kwargs): - """Set subnet attributes. + r"""Set subnet attributes. :param subnet: Name of subnet for which to set attribute. :type subnet: str @@ -1494,7 +1494,7 @@ def set_subnet(self, subnet, **kwargs): return self._request("PUT", "subnet/{0}".format(subnet), kwargs) def create_vlan_interface(self, interface, subnet, **kwargs): - """Create a vlan interface + r"""Create a vlan interface :param interface: Name of interface to be created. :type interface: str @@ -1545,7 +1545,7 @@ def get_dns(self): return self._request("GET", "dns") def set_dns(self, **kwargs): - """Set DNS settings. + r"""Set DNS settings. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1561,7 +1561,7 @@ def set_dns(self, **kwargs): # ports def list_ports(self, **kwargs): - """List SAN ports. + r"""List SAN ports. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1600,7 +1600,7 @@ def list_drives(self): return self._request("GET", "drive") def get_hardware(self, component, **kwargs): - """Returns a dictionary describing a hardware component. + r"""Returns a dictionary describing a hardware component. :param component: Name of hardware component to get information about. :type component: str @@ -1616,7 +1616,7 @@ def get_hardware(self, component, **kwargs): return self._request("GET", "hardware/{0}".format(component), kwargs) def list_hardware(self, **kwargs): - """Returns a list of dictionaries describing hardware. + r"""Returns a list of dictionaries describing hardware. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1630,7 +1630,7 @@ def list_hardware(self, **kwargs): return self._request("GET", "hardware", kwargs) def set_hardware(self, component, **kwargs): - """Set an attribute of a hardware component. + r"""Set an attribute of a hardware component. :param component: Name of component for which to set attribute. :type component: str @@ -1660,7 +1660,7 @@ def _list_admin(self, **kwargs): return self._request("GET", "admin", kwargs) def list_admins(self, **kwargs): - """Return a list of dictionaries describing local admins. + r"""Return a list of dictionaries describing local admins. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1678,7 +1678,7 @@ def list_admins(self, **kwargs): return self._list_admin(**kwargs) def create_admin(self, admin, **kwargs): - """Create an admin. + r"""Create an admin. :param admin: Name of admin. :type admin: str @@ -1713,7 +1713,7 @@ def delete_admin(self, admin): return self._request("DELETE", "admin/{0}".format(admin)) def set_admin(self, admin, **kwargs): - """Set an attribute of an admin. + r"""Set an attribute of an admin. :param admin: Name of admin for whom to set an attribute. :type admin: str @@ -1732,7 +1732,7 @@ def set_admin(self, admin, **kwargs): return self._request("PUT", "admin/{0}".format(admin), kwargs) def create_api_token(self, admin, **kwargs): - """Create an API token for an admin. + r"""Create an API token for an admin. :param admin: Name of admin for whom to create an API token. :type admin: str @@ -1776,7 +1776,7 @@ def get_admin(self, admin): return self._request("GET", "admin/{0}".format(admin)) def get_publickey(self, admin): - """Returns a dictionary describing an admin's public key. + r"""Returns a dictionary describing an admin's public key. :param admin: Name of admin whose public key to get. :type admin: str @@ -1789,7 +1789,7 @@ def get_publickey(self, admin): {"publickey": True}) def get_api_token(self, admin, **kwargs): - """Return a dictionary describing an admin's API token. + r"""Return a dictionary describing an admin's API token. :param admin: Name of admin whose API token to get. :type admin: str @@ -1805,7 +1805,7 @@ def get_api_token(self, admin, **kwargs): return self._request("GET", "admin/{0}/apitoken".format(admin)) def list_publickeys(self): - """Return a list of dictionaries describing public keys. + r"""Return a list of dictionaries describing public keys. :returns: A list of dictionaries mapping "name" to a username and "publickey" to "\*\*\*\*" for each admin with a public @@ -1816,7 +1816,7 @@ def list_publickeys(self): return self._list_admin(publickey=True) def list_api_tokens(self, **kwargs): - """Return a list of dictionaries describing REST API tokens. + r"""Return a list of dictionaries describing REST API tokens. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1836,7 +1836,7 @@ def list_api_tokens(self, **kwargs): return self._list_admin(api_token=True, **kwargs) def refresh_admin(self, admin, **kwargs): - """Refresh the admin permission cache for the specified admin. + r"""Refresh the admin permission cache for the specified admin. :param admin: Name of admin whose permission cache is to be refreshed. :type admin: str @@ -1871,7 +1871,7 @@ def refresh_admins(self): {"action": "refresh", "clear": True}) def set_publickey(self, admin, key): - """Set the public key associated with an admin. + r"""Set the public key associated with an admin. :param admin: Name of admin whose public key is to be set. :type admin: str @@ -1937,7 +1937,7 @@ def enable_directory_service(self, check_peer=False): return self.set_directory_service(enabled=True) def get_directory_service(self, **kwargs): - """Return a dictionary describing directory service configuration. + r"""Return a dictionary describing directory service configuration. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1951,7 +1951,7 @@ def get_directory_service(self, **kwargs): return self._request("GET", "directoryservice", kwargs) def set_directory_service(self, **kwargs): - """Set an attribute of the directory service configuration. + r"""Set an attribute of the directory service configuration. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1975,7 +1975,7 @@ def test_directory_service(self): return self.set_directory_service(action="test") def list_directory_service_roles(self, **kwargs): - """Get directory service groups for roles. + r"""Get directory service groups for roles. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -1994,7 +1994,7 @@ def list_directory_service_roles(self, **kwargs): return self._request("GET", "directoryservice/role", kwargs) def set_directory_service_roles(self, **kwargs): - """Set directory service groups for roles. + r"""Set directory service groups for roles. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -2030,7 +2030,7 @@ def get_global_admin_attributes(self): return self._request("GET", "admin/settings") def set_global_admin_attributes(self, **kwargs): - """Set the global admin attributes. + r"""Set the global admin attributes. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -2293,7 +2293,7 @@ def list_alert_recipients(self): return self._request("GET", "alert") def list_messages(self, **kwargs): - """Return a list of alert messages. + r"""Return a list of alert messages. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -2333,7 +2333,7 @@ def test_alert_recipient(self, address): # def create_snmp_manager(self, manager, host, **kwargs): - """Create an SNMP manager. + r"""Create an SNMP manager. :param manager: Name of manager to be created. :type manager: str @@ -2413,7 +2413,7 @@ def rename_snmp_manager(self, manager, name): return self.set_snmp_manager(manager, name=name) def set_snmp_manager(self, manager, **kwargs): - """Set an attribute of an SNMP manager. + r"""Set an attribute of an SNMP manager. :param manager: Name of the SNMP manager for which to set an attribute. :type manager: str @@ -2446,7 +2446,7 @@ def test_snmp_manager(self, manager): # def connect_array(self, address, connection_key, connection_type, **kwargs): - """Connect this array with another one. + r"""Connect this array with another one. :param address: IP address or DNS name of other array. :type address: str @@ -2508,7 +2508,7 @@ def list_array_connections(self, **kwargs): return self._request("GET", "array/connection", kwargs) def throttle_array_connection(self, address, **kwargs): - """Set bandwidth limits on a connection. + r"""Set bandwidth limits on a connection. :param address: IP address or DNS name of other array. :type address: str @@ -2530,7 +2530,7 @@ def throttle_array_connection(self, address, **kwargs): # Protection group related methods def create_pgroup(self, pgroup, **kwargs): - """Create pgroup with specified name. + r"""Create pgroup with specified name. :param pgroup: Name of pgroup to be created. :type pgroup: str @@ -2550,7 +2550,7 @@ def create_pgroup(self, pgroup, **kwargs): return self._request("POST", "pgroup/{0}".format(pgroup), kwargs) def create_pgroup_snapshot(self, source, **kwargs): - """Create snapshot of pgroup from specified source. + r"""Create snapshot of pgroup from specified source. :param source: Name of pgroup of which to take snapshot. :type source: str @@ -2579,7 +2579,7 @@ def create_pgroup_snapshot(self, source, **kwargs): return result def send_pgroup_snapshot(self, source, **kwargs): - """ Send an existing pgroup snapshot to target(s) + r""" Send an existing pgroup snapshot to target(s) :param source: Name of pgroup snapshot to send. :type source: str @@ -2601,7 +2601,7 @@ def send_pgroup_snapshot(self, source, **kwargs): return self._request("POST", "pgroup", data) def create_pgroup_snapshots(self, sources, **kwargs): - """Create snapshots of pgroups from specified sources. + r"""Create snapshots of pgroups from specified sources. :param sources: Names of pgroups of which to take snapshots. :type sources: list of str @@ -2623,7 +2623,7 @@ def create_pgroup_snapshots(self, sources, **kwargs): return self._request("POST", "pgroup", data) def destroy_pgroup(self, pgroup, **kwargs): - """Destroy an existing pgroup or pgroup snapshot. + r"""Destroy an existing pgroup or pgroup snapshot. :param pgroup: Name of pgroup(snap) to be destroyed. :type pgroup: str @@ -2706,7 +2706,7 @@ def enable_pgroup_snapshots(self, pgroup): return self.set_pgroup(pgroup, snap_enabled=True) def eradicate_pgroup(self, pgroup, **kwargs): - """Eradicate a destroyed pgroup. + r"""Eradicate a destroyed pgroup. :param pgroup: Name of pgroup to be eradicated. :type pgroup: str @@ -2728,7 +2728,7 @@ def eradicate_pgroup(self, pgroup, **kwargs): return self._request("DELETE", "pgroup/{0}".format(pgroup), eradicate) def get_pgroup(self, pgroup, **kwargs): - """Return dictionary describing a pgroup or snapshot. + r"""Return dictionary describing a pgroup or snapshot. :param pgroup: Name of pgroup to get information about. :type pgroup: str @@ -2750,7 +2750,7 @@ def get_pgroup(self, pgroup, **kwargs): return self._request("GET", "pgroup/{0}".format(pgroup), kwargs) def list_pgroups(self, **kwargs): - """Return list dictionaries describing each pgroup. + r"""Return list dictionaries describing each pgroup. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -2768,7 +2768,7 @@ def list_pgroups(self, **kwargs): return self._request("GET", "pgroup", kwargs) def recover_pgroup(self, pgroup, **kwargs): - """Recover a destroyed pgroup that has not yet been eradicated. + r"""Recover a destroyed pgroup that has not yet been eradicated. :param pgroup: Name of pgroup to be recovered. :type pgroup: str @@ -2806,7 +2806,7 @@ def rename_pgroup(self, pgroup, name): return self.set_pgroup(pgroup, name=name) def set_pgroup(self, pgroup, **kwargs): - """Set an attribute of a pgroup. + r"""Set an attribute of a pgroup. :param pgroup: Name of pgroup for which to set attribute. :type pgroup: str @@ -2826,7 +2826,7 @@ def set_pgroup(self, pgroup, **kwargs): return self._request("PUT", "pgroup/{0}".format(pgroup), kwargs) def create_vgroup(self, vgroup, **kwargs): - """Create a vgroup. + r"""Create a vgroup. :param vgroup: Name of vgroup to be created. :type vgroup: str @@ -2879,7 +2879,7 @@ def eradicate_vgroup(self, vgroup): {"eradicate": True}) def get_vgroup(self, vgroup, **kwargs): - """Return dictionary describing a vgroup. + r"""Return dictionary describing a vgroup. :param vgroup: Name of vgroup to get information about. :type vgroup: str @@ -2900,7 +2900,7 @@ def get_vgroup(self, vgroup, **kwargs): return self._request("GET", "vgroup/{0}".format(vgroup), kwargs) def list_vgroups(self, **kwargs): - """Return list dictionaries describing each vgroup. + r"""Return list dictionaries describing each vgroup. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -2952,7 +2952,7 @@ def rename_vgroup(self, vgroup, name): return self.set_vgroup(vgroup, name=name) def set_vgroup(self, vgroup, **kwargs): - """Set an attribute of a vgroup. + r"""Set an attribute of a vgroup. :param vgroup: Name of vgroup for which to set attribute. :type vgroup: str @@ -2976,7 +2976,7 @@ def set_vgroup(self, vgroup, **kwargs): # def set_pod(self, pod, **kwargs): - """Perform actions on a pod and return a dictionary describing it. + r"""Perform actions on a pod and return a dictionary describing it. :param pod: Name of the for which to set attribute. :type pod: str @@ -2996,7 +2996,7 @@ def set_pod(self, pod, **kwargs): return self._request("PUT", "pod/{0}".format(pod), kwargs) def create_pod(self, pod, **kwargs): - """Create a pod and return a dictionary describing it. + r"""Create a pod and return a dictionary describing it. :param pod: Name of the pod to be created. :type pod: str @@ -3015,7 +3015,7 @@ def create_pod(self, pod, **kwargs): return self._request("POST", "pod/{0}".format(pod), kwargs) def clone_pod(self, source, dest, **kwargs): - """Clone an existing pod to a new one. + r"""Clone an existing pod to a new one. :param source: Name of the pod the be cloned. :type source: str @@ -3086,7 +3086,7 @@ def eradicate_pod(self, pod): {"eradicate": True}) def get_pod(self, pod, **kwargs): - """Return a dictionary describing a pod. + r"""Return a dictionary describing a pod. :param pod: Name of the pod to get information about. :type pod: str @@ -3123,7 +3123,7 @@ def add_pod(self, pod, array): return self._request("POST", "pod/{0}/array/{1}".format(pod, array)) def remove_pod(self, pod, array, **kwargs): - """Remove arrays from a pod. + r"""Remove arrays from a pod. :param pod: Name of the pod. :type pod: str @@ -3144,7 +3144,7 @@ def remove_pod(self, pod, array, **kwargs): return self._request("DELETE", "pod/{0}/array/{1}".format(pod, array), kwargs) def list_pods(self, **kwargs): - """Return a list of dictionaries describing each pod. + r"""Return a list of dictionaries describing each pod. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3209,7 +3209,7 @@ def recover_pod(self, pod): # def get_certificate(self, **kwargs): - """Get the attributes of the current array certificate. + r"""Get the attributes of the current array certificate. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3232,7 +3232,7 @@ def get_certificate(self, **kwargs): return self._request("GET", "cert", kwargs) def list_certificates(self): - """Get the attributes of the current array certificate. + r"""Get the attributes of the current array certificate. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3260,7 +3260,7 @@ def list_certificates(self): return out def get_certificate_signing_request(self, **kwargs): - """Construct a certificate signing request (CSR) for signing by a + r"""Construct a certificate signing request (CSR) for signing by a certificate authority (CA). :param \*\*kwargs: See the REST API Guide on your array for the @@ -3289,7 +3289,7 @@ def get_certificate_signing_request(self, **kwargs): return self._request("GET", "cert/certificate_signing_request", kwargs) def set_certificate(self, **kwargs): - """Modify an existing certificate, creating a new self signed one + r"""Modify an existing certificate, creating a new self signed one or importing a certificate signed by a certificate authority (CA). :param \*\*kwargs: See the REST API Guide on your array for the @@ -3323,7 +3323,7 @@ def set_certificate(self, **kwargs): # def create_certificate(self, name, **kwargs): - """Create a new managed certificate. + r"""Create a new managed certificate. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3343,7 +3343,7 @@ def create_certificate(self, name, **kwargs): return self._request("POST", "cert/{0}".format(name), kwargs) def delete_certificate(self, name, **kwargs): - """Delete a managed certificate. + r"""Delete a managed certificate. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3367,7 +3367,7 @@ def delete_certificate(self, name, **kwargs): # def create_kmip(self, name, **kwargs): - """Create a new kmip configuration. + r"""Create a new kmip configuration. :param name: The name of the KMIP config to operate on. :type name: string @@ -3432,7 +3432,7 @@ def get_kmip(self, name): return self._request("GET", "kmip/{0}".format(name)) def set_kmip(self, name, **kwargs): - """Modify an existing kmip configuration. + r"""Modify an existing kmip configuration. :param name: The name of the KMIP config to operate on. :type name: string @@ -3472,7 +3472,7 @@ def test_kmip(self, name): # def list_app_software(self, **kwargs): - """List app software. + r"""List app software. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3489,7 +3489,7 @@ def list_app_software(self, **kwargs): return self._request("GET", "software/app", kwargs) def get_app_software(self, name, **kwargs): - """List the specified app software. + r"""List the specified app software. :param name: The name of the app. :type name: string @@ -3534,7 +3534,7 @@ def uninstall_app(self, name, **kwargs): # def list_apps(self, **kwargs): - """Returns a list of dictionaries describing apps. + r"""Returns a list of dictionaries describing apps. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3548,7 +3548,7 @@ def list_apps(self, **kwargs): return self._request("GET", "app", kwargs) def get_app(self, name, **kwargs): - """Returns a list of dictionaries describing the app. + r"""Returns a list of dictionaries describing the app. :param name: The name of the app. :type name: string @@ -3596,7 +3596,7 @@ def disable_app(self, name): # def get_smtp(self): - """Get the attributes of the current smtp server configuration. + r"""Get the attributes of the current smtp server configuration. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3612,7 +3612,7 @@ def get_smtp(self): return self._request("GET", "smtp") def set_smtp(self, **kwargs): - """Set the attributes of the current smtp server configuration. + r"""Set the attributes of the current smtp server configuration. :param \*\*kwargs: See the REST API Guide on your array for the documentation on the request: @@ -3630,7 +3630,7 @@ def set_smtp(self, **kwargs): @staticmethod def page_through(page_size, function, *args, **kwargs): - """Return an iterator over all pages of a REST operation. + r"""Return an iterator over all pages of a REST operation. :param page_size: Number of elements to retrieve per call. :param function: FlashArray function that accepts limit as an argument.