Skip to content

Advanced Topics

This guide covers advanced features and techniques for working with the Strata Cloud Manager SDK.

Pagination

When listing objects, the API may return paginated results. The SDK provides methods to handle pagination automatically or manually.

Automatic Pagination

By default, the SDK's list methods handle pagination automatically and return all results:

# Get all address objects (automatically handling pagination)
all_addresses = client.address.list()

Manual Pagination

You can also control pagination manually:

# Get the first page of results with a specific limit
first_page = client.address.list(limit=50)

# If you need to implement your own pagination logic
offset = 0
limit = 50
all_results = []

while True:
    page = client.address.list(offset=offset, limit=limit)
    all_results.extend(page)

    if len(page) < limit:
        # Reached the end of results
        break

    offset += limit

Advanced Filtering

The SDK supports filtering results using the OData syntax:

Basic Filters

# Filter by name
filtered = client.address.list(filter="name eq 'web-server'")

# Filter by folder
filtered = client.address.list(filter="folder eq 'Texas'")

Compound Filters

# Multiple conditions (AND)
filtered = client.address.list(filter="name eq 'web-server' and folder eq 'Texas'")

# Multiple conditions (OR)
filtered = client.address.list(filter="name eq 'web-server' or name eq 'db-server'")

Filter Operators

# Contains
filtered = client.address.list(filter="contains(name, 'server')")

# Starts with
filtered = client.address.list(filter="startswith(name, 'web')")

# Numeric comparisons
filtered = client.nat_rules.list(filter="destinationPort gt 1000")

Performance Optimization

Requesting Specific Fields

To reduce response size and improve performance, you can specify which fields to return:

# Only retrieve specific fields
addresses = client.address.list(fields="id,name,ip_netmask")

Batch Operations

For multiple operations, it's more efficient to use batch processing:

# Create multiple objects efficiently
objects_to_create = [
    {"name": "web-server-1", "folder": "Texas", "ip_netmask": "192.168.1.100/32"},
    {"name": "web-server-2", "folder": "Texas", "ip_netmask": "192.168.1.101/32"},
    {"name": "web-server-3", "folder": "Texas", "ip_netmask": "192.168.1.102/32"}
]

for obj in objects_to_create:
    client.address.create(obj)

# Then commit once
client.candidate_push({
    "description": "Adding web server addresses",
    "admin_name": "admin"
})

Error Handling and Retries

Custom Retry Logic

For operations that might fail temporarily, you can implement retry logic:

import time
from scm.exceptions import ApiError

def retry_operation(operation_func, max_retries=3, retry_delay=2):
    retries = 0
    while retries < max_retries:
        try:
            return operation_func()
        except ApiError as e:
            if e.status_code in [429, 503]:  # Rate limit or service unavailable
                retries += 1
                if retries < max_retries:
                    time.sleep(retry_delay * retries)  # Exponential backoff
                else:
                    raise
            else:
                raise

# Usage example
def create_address():
    return client.address.create({
        "name": "web-server",
        "folder": "Texas",
        "ip_netmask": "192.168.1.100/32"
    })

new_address = retry_operation(create_address)

Debugging API Interactions

For troubleshooting, you can enable debug logging:

import logging
logging.basicConfig(level=logging.DEBUG)

Working with Custom Token URLs

The SDK supports specifying a custom token URL for environments that use different authentication endpoints:

from scm import Scm

# Initialize with a custom token URL
client = Scm(
    client_id="your-client-id",
    client_secret="your-client-secret",
    tenant_id="your-tenant-id",
    token_url="https://custom-auth-endpoint.example.com/oauth2/token"
)

Next Steps