返回文章列表
玄貓（BlackCat）

NetScaler SOAP API 裝置管理實踐

本文探討如何使用 SOAP API 管理 NetScaler 裝置，涵蓋從基礎認證到資源管理，以及使用 Python 操作 NITRO API 的實務技巧，包含連線管理、資源繫結、統計資料取得、虛擬伺服器管理等關鍵導向，並提供程式碼範例和詳細說明，最後延伸探討如何建構 IP 位址管理 Web

Web 開發 系統管理
NetScaler SOAP API NITRO API Python 負載平衡 API 整合

NetScaler 作為應用交付控制器（ADC），在應用程式交付最佳化和安全性提升方面扮演著重要角色。本文將探討如何利用 SOAP API 與 NetScaler 互動，實作自動化管理和資源組態。首先介紹 NetScaler 的 NITRO API 架構，並以 Python 為例示範如何建立連線、進行認證，以及管理資源，例如負載平衡虛擬伺服器和服務的繫結。接著，將詳細說明如何使用 SOAP API 取得系統和虛擬伺服器的統計資料，例如 CPU 使用率、記憶體用量、虛擬伺服器狀態等，並提供程式碼範例和解說，以幫助讀者快速上手。最後，延伸探討如何建構一個根據 Web 的 IP 位址管理應用程式，從需求定義、資料函式庫結構設計到功能實作，提供一個完整的實務案例，讓讀者瞭解如何整合 NetScaler 的 API 到實際應用中。

管理 NetScaler 裝置：使用 SOAP API 的實踐

NetScaler 是一款功能強大的應用交付控制器（ADC），它能夠最佳化應用程式的交付，提高安全性，並簡化 IT 基礎設施的管理。在本章中，我們將探討如何使用 SOAP API 管理 NetScaler 裝置，涵蓋從基礎認證到資源管理的各個方面。

瞭解 NetScaler 的 NITRO API

NetScaler 的 NITRO API 是一套全面的 API，允許管理員透過程式設計方式與 NetScaler 裝置進行互動。NITRO API 支援多種程式語言，包括 Python、Java 和 .NET 等，使得自動化和整合變得更加容易。

Python 中的 NITRO API 使用

在 Python 中使用 NITRO API 需要匯入相應的模組。這些模組通常以 Python 檔案的形式存在，每個檔案對應於 NetScaler 中的一個特定資源或功能。例如，lbvserver.py 檔案包含了與負載平衡虛擬伺服器（LBvserver）相關的資源定義。

# 從 NITRO API 中匯入 nitro_service 類別
from nssrc.com.citrix.netscaler.nitro.service.nitro_service import nitro_service

# 建立一個 nitro_service 例項
client = nitro_service('192.168.0.100', 'http')

# 設定登入憑證
client.set_credential('nsroot', 'nsroot')

# 設定連線逾時時間
client.timeout = 10

# 登入 NetScaler
client.login()

認證與連線管理

在使用 NITRO API 之前，您需要先與 NetScaler 建立連線並進行認證。這涉及到建立 nitro_service 類別的例項、設定登入憑證以及呼叫 login() 方法。

# 檢查是否已登入
print(client.isLogin())

# 登入後再次檢查
client.login()
print(client.isLogin())

#### 內容解密：

  1. 建立 nitro_service 例項：這是與 NetScaler 建立連線的第一步，需要指定 NetScaler 的 IP 地址和使用的通訊協定（HTTP 或 HTTPS）。
  2. 設定登入憑證：使用 set_credential() 方法設定用於登入 NetScaler 的使用者名稱和密碼。
  3. 設定連線逾時時間：透過設定 timeout 屬性，可以避免連線因為長時間無活動而被斷開。
  4. 登入 NetScaler：呼叫 login() 方法完成認證。如果認證成功，將傳回一個表示成功的回應物件。
  5. isLogin() 方法：用於檢查當前是否已登入狀態。

使用 NITRO API 管理資源

成功登入後，您就可以使用 NITRO API 對 NetScaler 中的各種資源進行管理，例如建立、更新、刪除負載平衡虛擬伺服器、服務等。

繫結資源：一個重要的概念

在 NetScaler 中，資源之間的繫結是一種常見的操作。例如，將服務繫結到負載平衡虛擬伺服器上。這種繫結關係在 NITRO API 中透過特定的資源（如 lbvserver_service_binding）來表示。

# 這裡展示了一個關於如何使用 NITRO API 繫結服務到 LBvserver 的概念
# 真實的程式碼需要根據具體的 NITRO API 版本和資源型別進行調整

#### 內容解密：

  1. 理解繫結資源的概念：在 NetScaler 中，許多組態涉及到資源之間的繫結，如將服務繫結到 LBvserver。
  2. 使用 NITRO API 進行資源繫結：透過特定的資源類別（如 lbvserver_service_binding），可以實作資源之間的繫結。
  3. 注意資源之間的關係：正確理解和管理資源之間的關係對於組態和管理 NetScaler 至關重要。

使用 SOAP API 管理 NetScaler 裝置

取得統計資料

當我們建立與 NetScaler 負載平衡器的連線後，便可利用 Client 物件進行溝通。所有與統計資料收集相關的類別都位於 nssrc/com/citrix/netscaler/nitro/resource/stats/ 子目錄下。

系統特定統計資料

系統特定的統計資料類別位於 nssrc/com/citrix/netscaler/nitro/resource/stat/system/ 套件中。這個套件包含以下模組：

  • systembw_stats.py
  • systemcpu_stats.py
  • systemmemory_stats.py
  • system_stats.py

若要取得 CPU 使用率的詳細資訊，我們需要使用 systemcpu_stats.py 模組中定義的類別。首先，我們需要初始化 session 物件，無需明確呼叫 login() 方法，因為程式函式庫會自動為我們完成這一步驟：

from nssrc.com.citrix.netscaler.nitro.service.nitro_service import nitro_service
from nssrc.com.citrix.netscaler.nitro.resource.stat.system.systemcpu_stats import systemcpu_stats

client = nitro_service('192.168.0.100', 'http')
client.set_credential('nsroot', 'nsroot')
client.timeout = 500

cpu_stats = systemcpu_stats.get(client)

內容解密：

  1. 初始化 Client 物件：nitro_service 函式用於建立與 NetScaler 裝置的連線，傳入裝置的 IP 地址和使用的協定（此處為 HTTP）。
  2. 設定憑證：set_credential 方法用於設定登入裝置所需的使用者名稱和密碼。
  3. 設定超時：timeout 屬性定義了操作的超時時間，單位通常是毫秒。
  4. 取得 CPU 統計資料：systemcpu_stats.get(client) 方法用於從 NetScaler 裝置取得 CPU 使用率的統計資料。

假設我們的裝置有六個 CPU，那麼回應將包含六個元素。我們可以透過迴圈遍歷 cpu_stats 來讀取實際的統計資料，例如每個 CPU 的使用率。

for c in cpu_stats:
    print(c.percpuuse)

取得記憶體使用率統計資料

同樣地，我們可以檢索關於記憶體使用情況的資料：

from nssrc.com.citrix.netscaler.nitro.resource.stat.system.systemmemory_stats import systemmemory_stats

mem_stats = systemmemory_stats.get(client)
print(mem_stats[0].memtotallocmb)

內容解密：

  1. 取得記憶體統計資料：systemmemory_stats.get(client) 方法用於取得記憶體使用情況的統計資料。
  2. memtotallocmb 屬性：表示目前已分配的記憶體大小，單位是兆位元組（MB）。

其他可用的屬性如表 2-6 所示，包括共用記憶體使用百分比、總記憶體使用量等。

虛擬伺服器特定統計資料

若要檢索有關負載平衡器裝置上執行的虛擬伺服器的資訊，我們需要使用 nssrc.com.citrix.netscaler.nitro/resource/stat/lb/lbvserver_stats 模組。

首先，讓我們檢查虛擬伺服器的狀態。在下面的例子中，我們檢索所有虛擬伺服器的統計資料，然後檢視每個伺服器的名稱和狀態：

from nssrc.com.citrix.netscaler.nitro.resource.stat.lb.lbvserver_stats import lbvserver_stats

lbvs_stats = lbvserver_stats.get(client)
for lbvs in lbvs_stats:
    print(f"{lbvs.name}: {lbvs.state}")

內容解密：

  1. 取得虛擬伺服器統計資料：lbvserver_stats.get(client) 方法用於取得所有虛擬伺服器的統計資料。
  2. 遍歷虛擬伺服器：透過迴圈遍歷 lbvs_stats，我們可以列印出每個虛擬伺服器的名稱和當前狀態。

如果我們需要檢索單一虛擬伺服器的詳細資訊，可以指定伺服器的名稱。在這種情況下，結果不是列表，而是一個單獨的物件。

lbvs_stats = lbvserver_stats.get(client, name="test_4")
print(lbvs_stats.state)

內容解密：

  1. 指定虛擬伺服器名稱：透過傳入 name 引數給 lbvserver_stats.get() 方法，我們可以取得特定虛擬伺服器的統計資料。
  2. 存取虛擬伺服器狀態：直接存取傳回物件的 state 屬性，即可獲得該虛擬伺服器的當前狀態。

更多屬性請參考 NetScaler REST API 檔案。表 2-7 列出了一些有用的虛擬伺服器特定屬性，如等待請求數、已建立連線數等。

管理裝置使用 SOAP API

使用 Python 存取 SOAP API

本章節將示範如何使用 Python 存取 SOAP API 來監控和管理 Citrix Netscaler 負載平衡器。同時，也將介紹如何組織自己的專案、結構化程式碼，以及如何處理錯誤和報告模組的功能狀態。

使用 nitro-python 套件

在開始之前，我們需要了解 nitro-python 套件的使用方法。這個套件提供了一種簡單的方式來存取 NetScaler 的 SOAP API。

from nssrc.com.citrix.netscaler.nitro.service.nitro_service import nitro_service
from nssrc.com.citrix.netscaler.nitro.resource.config.basic.server import server

# 建立一個 nitro_service 物件
client = nitro_service('192.168.0.100', 'http')
client.set_credential('nsroot', 'nsroot')

# 取得伺服器物件
srv_obj = server.get(client, name="test_srv_1")
print(srv_obj.state)

# 變更伺服器狀態
srv_obj.state = 'DISABLED'
server.update(client, srv_obj)

# 再次取得伺服器物件以確認狀態變更
srv_obj = server.get(client, name="test_srv_1")
print(srv_obj.state)

程式碼解析

  1. 建立 nitro_service 物件：首先，我們需要建立一個 nitro_service 物件，指定 NetScaler 的 IP 位址和通訊協定（在本例中為 HTTP）。
  2. 設定登入憑證：使用 set_credential 方法設定登入 NetScaler 所需的使用者名稱和密碼。
  3. 取得伺服器物件：使用 server.get 方法取得指定名稱的伺服器物件。
  4. 變更伺服器狀態：修改伺服器物件的 state 屬性，然後使用 server.update 方法將變更套用到 NetScaler。
  5. 確認狀態變更：再次取得伺服器物件以確認狀態是否已正確變更。

SOAP API 的基本原理

SOAP API 是一種遠端程式呼叫（RPC）的方法，允許客戶端應用程式呼叫遠端伺服器上的程式。它使用 XML 來結構化資料，並通常根據 HTTP 通訊協定。

SOAP API 的特點

  • 使用 XML 結構化資料
  • 根據 HTTP 通訊協定
  • 使用 WSDL 描述可用的服務和資料結構

建立 IP 位址統計 Web 應用程式

設計應用程式

在開發應用程式之前，首先需要定義需求和應用程式的設計。本章節將介紹如何設計一個簡單的 IP 位址統計 Web 應用程式。

設定需求

在開始設計之前，需要了解應用程式的需求。以下是一些基本需求：

  • 系統必須是集中式的，但可以被多個使用者存取
  • 應用程式必須能夠儲存 IP 範圍和個別 IP 位址
  • 應用程式必須提供階層式組織 IP 範圍和個別 IP 位址的方法
  • 使用者必須能夠新增、移除和修改條目

應用程式設計

根據上述需求，可以開始設計應用程式。設計應獨立於實作技術，但通常會受到所選技術的影響。

建立 IP 地址管理 Web 應用程式

需求定義與設計決策

在建立 IP 地址管理系統時，首先需要明確系統的需求。根據需求定義，使用者必須能夠搜尋資訊、檢查使用 IP 位址的機器是否回應、取得所有 IP 位址的名稱記錄、為 IP 保留輸入描述，並易於擴充套件以使用 DHCP。這些需求將引導後續的設計與實作。

一旦需求確定，便可進行設計決策。由於本專案規模不大，因此無需撰寫正式的設計檔案。主要的設計決策包括：應用程式將根據 Web、使用 Python 和 Django 框架開發，並分為兩個階段實作：基本 IP 分配與保留功能，以及與 DHCP 的整合。

資料函式庫結構定義

根據需求，需要記錄以下資料：IP 範圍或個別 IP 位址、目前範圍所屬的上層範圍、以及每個記錄是否允許為空。為了更好地理解資料函式庫結構的設計，我們需要了解 IP 位址的工作原理。

IP 位址的工作原理

每個 IP 位址包含兩個部分：網路位址部分和主機位址部分。在 IPv4 中，一個完整的 IP 位址始終是 32 位元長。在引入無類別域間路由（CIDR）之前，僅有三種可用的網路區塊或類別：A 類別、B 類別和 C 類別。CIDR 允許使用任意長度的網路位址。例如，位址 192.168.1.1/24 表示這是一個 C 類別網路位址，其前 24 位元是網路位址。

@startuml
skinparam backgroundColor #FEFEFE
skinparam sequenceArrowThickness 2

title NetScaler SOAP API 裝置管理實踐

actor "客戶端" as client
participant "API Gateway" as gateway
participant "認證服務" as auth
participant "業務服務" as service
database "資料庫" as db
queue "訊息佇列" as mq

client -> gateway : HTTP 請求
gateway -> auth : 驗證 Token
auth --> gateway : 認證結果

alt 認證成功
    gateway -> service : 轉發請求
    service -> db : 查詢/更新資料
    db --> service : 回傳結果
    service -> mq : 發送事件
    service --> gateway : 回應資料
    gateway --> client : HTTP 200 OK
else 認證失敗
    gateway --> client : HTTP 401 Unauthorized
end

@enduml

此圖示展示了 IP 位址的組成部分及其 CIDR 表示法。

資料函式庫結構設計

根據 IP 位址的工作原理和系統需求，資料函式庫結構需要能夠有效地儲存和管理 IP 位址及其相關資訊。具體來說，需要考慮如何儲存 IP 範圍、上層範圍、以及每個記錄的屬性等。

資料函式庫表格設計
CREATE TABLE ip_addresses (
    id SERIAL PRIMARY KEY,
    ip_address VARCHAR(45) NOT NULL,
    parent_range_id INTEGER,
    is_allowed_empty BOOLEAN NOT NULL DEFAULT FALSE,
    description TEXT,
    FOREIGN KEY (parent_range_id) REFERENCES ip_addresses(id)
);

程式碼解密：

此 SQL 程式碼用於建立一個名為 ip_addresses 的資料表，用於儲存 IP 位址相關資訊。其中：

  • id 欄位為主鍵，用於唯一標識每個 IP 位址記錄。
  • ip_address 欄位儲存 IP 位址。
  • parent_range_id 欄位用於參考上層範圍的 id，實作層級關係。
  • is_allowed_empty 欄位表示該記錄是否允許為空。
  • description 欄位用於儲存對該 IP 位址的描述。

此設計使得資料函式庫能夠有效地儲存和管理 IP 位址資訊，並支援層級查詢和相關操作。

建立 IP 位址核算的網頁應用程式

IP 位址結構解析

IP 位址是由網路位址和主機位址兩部分組成。例如，IP 位址 192.168.1.52 可以被分割成網路位址和主機位址。當主機位址設為 0 時，表示定義了一個網路範圍，如 192.168.1.32/27。若將主機位址設為全部 1，則得到該範圍內最後一個可能的 IP 位址，即廣播位址，如 192.168.1.63。若某個 IP 位址（如 192.168.1.93/27）不屬於該範圍，則表示它屬於不同的 IP 網路範圍，如 192.168.1.64/27。

瞭解 IP 位址的結構有助於我們更有效地定義資料函式庫結構。較大的網路範圍包含較小的網路範圍，例如一個 24 位元的網路可能包含兩個 25 位元的網路，或四個 26 位元的網路等。這種結構使我們能夠輕鬆檢查網路之間的父子關係。

資料儲存策略

為了方便資料函式庫系統的搜尋，我們將 IP 位址轉換為 32 位元整數儲存，並單獨儲存網路大小（以位元為單位）。這樣可以簡化計算範圍內的第一個和最後一個位址。以 IP 位址 192.168.1.52/27 為例，其 32 位元整數表示為 3232235828。透過二進位 AND 運算，可以得到其網路位址 3232235808。同樣地，可以計算出廣播位址為 3232235840。

資料函式庫結構定義

根據上述分析，我們可以定義一個簡單的資料函式庫結構，如下表所示：

表 3-1：網路定義結構的欄位

欄位名稱資料型態說明
Record IDInteger主鍵，唯一且自動遞增
AddressInteger關鍵欄位，表示 32 位元的網路位址
Network sizeInteger關鍵欄位，決定網路部分的位元數
DescriptionText必填欄位，描述該 IP 的用途

應用程式工作流程設計

由於該應用程式相對簡單，我們無需使用正式的規格語言（如 UML）來定義應用程式行為和工作流程。我們將以簡短的陳述描述每個功能需求，以及資訊如何呈現給最終使用者。

搜尋與顯示功能

搜尋功能將根據 IP 位址或描述中的子字串進行搜尋，並傳回符合條件的專案列表。顯示功能將展示目前選定位址的資訊（包括位址、網路位元數、範圍起始和結束位址），並列出所有子專案，即屬於選定位址的所有位址或網路。點選任何子專案將觸發新的搜尋和顯示操作。

新增功能

新增功能允許使用者新增子專案。表單將要求輸入新專案的詳細資訊，如 IP 位址和描述，並建立相應的資料函式庫專案。若新增成功，表單將傳回前一頁面。

在新增專案時，該功能必須驗證輸入的 IP 位址是否有效，並檢查該位址是否為目前父網路的子集。

功能實作考量

在實作上述功能時，我們需要考慮以下幾點：

  1. 健康檢查功能：對每個子專案執行健康檢查，以判斷該位址是否正在回應。
  2. 名稱解析程式：呼叫名稱解析程式以取得 DNS 名稱，並相應地顯示資訊。
  3. 父專案連結：提供連結到父專案的功能，以便使用者可以在樹狀結構中上下移動。
  4. 輸入驗證：在新增或編輯專案時，必須驗證輸入資料的有效性。

綜上所述，我們已經定義了一個簡單而有效的資料函式庫結構和應用程式工作流程，能夠滿足 IP 位址核算的需求。接下來，我們將根據這些設計原則進行具體的實作。

CREATE TABLE networks (
    record_id INTEGER PRIMARY KEY AUTOINCREMENT,
    address INTEGER NOT NULL,
    network_size INTEGER NOT NULL,
    description TEXT NOT NULL
);

內容解密：

此 SQL 陳述式建立了一個名為 networks 的資料表，用於儲存網路相關資訊。其中包含四個欄位：

  • record_id：主鍵，自動遞增，確保每筆記錄的唯一性。
  • address：儲存 IP 位址對應的 32 位元整數表示。
  • network_size：儲存網路大小，以位元為單位。
  • description：用於描述該 IP 位址的用途或所屬網路的相關資訊。

這張表的設計簡潔明瞭，能夠有效地儲存和管理 IP 位址相關資料，為後續的查詢和管理操作提供了基礎。