service_edge_schedule

The following methods allow for interaction with the ZPA Service Edge Schedule API endpoints.

Methods are accessible via zpa.service_edge_schedule

Copyright (c) 2023, Zscaler Inc.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class ServiceEdgeScheduleAPI

Bases: APIClient

A Client object for the Service Edge Schedule resource.

add_service_edge_schedule(schedule)

Configure an Service Edge schedule frequency to delete inactive connectors based on the configured frequency.

Parameters:

schedule (dict) – Dictionary containing: frequency (str): Frequency at which disconnected Service Edges are deleted. interval (str): Interval for the frequency value. disabled (bool, optional): Whether to include disconnected connectors for deletion. enabled (bool, optional): Whether the deletion setting is enabled. microtenant_id (str): The unique identifier of the Microtenant for the ZPA tenant.

Returns:

A tuple containing (ServiceEdgeSchedule, Response, error)

Return type:

tuple

get_service_edge_schedule(customer_id=None)

Returns the configured Service Edge Schedule frequency.

Parameters:

  • customer_id (str, optional) – Unique identifier of the ZPA tenant. If not provided, will look up from env var.

  • query_params (dict, optional) – Map of query parameters for the request. [query_params.microtenant_id] {str}: The microtenant ID, if applicable.

Returns:

A tuple containing (ServiceEdgeSchedule, Response, error)

Return type:

tuple

update_service_edge_schedule(scheduler_id, schedule)

Updates Service Edge schedule frequency to delete inactive connectors based on the configured frequency.

Parameters:

  • **scheduler_id (str) – Unique identifier for the schedule.

  • **frequency (str) – Frequency at which disconnected Service Edges are deleted.

  • **interval (str) – Interval for the frequency value.

  • **disabled (bool) – Whether to include disconnected connectors for deletion.

  • **enabled (bool) – Whether the deletion setting is enabled.

  • **microtenant_id (str) – The unique identifier of the Microtenant for the ZPA tenant.

Returns:

A tuple containing (ServiceEdgeSchedule, Response, error)

Return type:

tuple