ZTP との互換性を確保するために、Cisco Crosswork のインストールは次の前提条件を満たしている必要があります。

• ZTP にデバイスを Cisco NSO へオンボーディングさせる場合は、NSO を Cisco Crosswork プロバイダとして 設定します。必ず NSO プロバイダのプロパティキーを forward に、プロパティ値を true に設定してください。

• Cisco Crosswork クラスタノードはデバイスから、ノードはデバイスから、アウトオブバンド管理ネットワークまたはインバウンド データ ネットワークのいずれかを介して到達可能である必要があります。これらの要件の範囲の一般的な表示については、 『Cisco Crosswork Infrastructure and Applications Installation Guide』の「Network Requirements」の項にあるネットワーク図を参照してください。このタイプのアクセスを有効にするには、ファイアウォール設定変更が必要な場合があります。

• Crosswork ZTP を使用してオンボーディングする Crosswork クラスタノードとデバイスがまったく異なるサブネットにある場合は、Crosswork ノードからデバイスサブネットへの 1 つ以上の静的ルートを設定する必要があります。メインメニューからこれを行うには、[管理（Administration）] > [設定（Settings）] > [静的ルート（Static Routes）] を選択します。 をクリックし、接続先サブネットの IP アドレスとマスク（スラッシュ表記）を入力して、[追加（Add）] をクリックします。

「ZTP アセット」という用語は、次の表に示すファイル、クレデンシャル、およびその他のアセットを指します。使用する予定の ZTP モードに応じて、それらのうちの一部が必要です。

Cisco Crosswork ZTP は、次の ZTP アセットを使用します。

• ソフトウェアイメージ：ネットワークデバイスが機能できるようにするインストール可能なネットワーク オペレーティング システム ソフトウェア（Cisco IOS-XR など。または PnP ZTP の場合は Cisco IOS-XE など）。ソフトウェアイメージは、デバイスがイメージ化されていない場合、またはネットワーク OS をアップグレードする場合にのみ必要です。シスコは、IOS-XR イメージを TAR、ISO、BIN、または RPM ファイルとして配布しています。シスコでは、IOS-XE イメージを常に BIN ファイルとして配布しています。各イメージファイルは、特定のデバイスプラットフォームまたはファミリの特定のネットワーク OS の単一リリースを表します。Cisco Crosswork にイメージファイルを 1 つずつアップロードし、アップロードの準備時にソフトウェア イメージ ファイル ごとに MD5 チェックサムを入力します。Cisco Crosswork は MD5 チェックサムを使用してファイルの整合性を検証します。シスコまたはサードパーティの製造元からデバイスイメージをダウンロードする場合は、チェックサムを必ず記録してください。アップロードするイメージの独自の MD5 チェックサムを生成することもできます。ZTP では、すでにイメージ化されているデバイスにソフトウェアイメージを適用する必要はありません。

• ソフトウェア メンテナンスの更新（SMU）SMU は、特定のソフトウェアリリースの 1 つ以上の重大な問題をポイント修正できるようにするシスコのソフトウェアパッケージです。シスコは、関連する問題を説明する readme.txt ファイルを使用してブート不可形式の SMU を配布しています。シスコは、ソフトウェアイメージの次のメンテナンスリリースに SMU のコンテンツを展開します。クラシック ZPT とセキュア ZTP の場合は、ソフトウェアイメージのダウンロード時ではないときに、設定ファイルを使用して SMU を適用し、それらのファイルを 1 つずつ Cisco Crosswork にアップロードしてください。PnP ZTP の場合、SMU ファイルは Cisco IOS-XE ではサポートされません。

• 設定：クラシック ZTP とセキュア ZTP は設定ファイルを使用して、SMU を使用したソフトウェアのアップグレードなど、特定のデバイスにインストールされているソフトウェアイメージの機能を設定します。これら 2 つの ZTP モードで使用される設定ファイルは、Linux シェルスクリプト（SH）、Python スクリプト（PY）、または ASCII テキストファイル（TXT）に保存されたデバイスのオペレーティングシステムの CLI コマンドです。Cisco PnP ZTP は、Cisco ASR 900 デバイスと Cisco NCS 520 デバイスでは Day 0 設定 TXT ファイルのみをサポートします。PnP ZTP 設定ファイルでは、IOS-XE CLI コマンドを使用する必要があります。PnP ZTP は、Linux シェル（SH）または Python（PY）スクリプトファイルをサポートしていません。組織またはコンサルタントがこれらの設定を作成します。Cisco Crosswork に設定ファイルを 1 つずつアップロードします。

• デバイスクレデンシャル：すべての Cisco Crosswork ZTP モードでは、デバイスへのアクセスやそれらの更新または設定にユーザー名とパスワードが必要です。これらを Cisco Crosswork クレデンシャルプロファイルとしてロードします。Cisco Crosswork は、暗号化された形式でクレデンシャルを保存します。GUI を使用してクレデンシャルプロファイルを 1 つずつ作成することも、クレデンシャルプロファイルの CSV ファイルをダウンロードして変更することで一括でロードすることもできます。

• シリアル番号：ZTP を使用してオンボーディングする予定のデバイスのシリアル番号。ZTP モードのいずれかを使用してオンボーディングする予定の各デバイスのシリアル番号を入力します。デバイスエントリを作成する前に、CSV ファイルをインポートして、シリアル番号を一括でロードします。セキュア ZTP を使用する場合は、所有権バウチャーを要求するときにシリアル番号をシスコに送信してください。

• 所有者証明書：所有者証明書と所有者キーの両方を Cisco Crosswork にロードして、各デバイスのリーフ証明書を生成できるようにします。

• 固定ドメイン証明書（PDC）：所有者証明書とともに PDC を Cisco Crosswork にロードします。また、所有権バウチャーを要求するときに PDC をシスコに送信します。

• 所有権バウチャー（OV）：他の証明書とともに OV をロードします。シスコまたはサードパーティの製造元に OV を要求する場合は、PDC とデバイスのシリアル番号を送信します。シスコは、準備が整った時点で、Tarball 内の 1 つ以上の VCJ ファイルとして OV を返します。この交換は、お客様とお客様のシスコアカウントチームが合意した安全な方法を使用して行われます。サードパーティ製デバイス用のバウチャーを使用している場合、製造元が提供する VCJ ファイルは命名規則 serial.vcj に従う必要があります。ここで、serial は対応するデバイスのシリアル番号です。Cisco Crosswork では、所有権バウチャーをデバイスにマッピングするために、このファイル命名規則が必要です。

• SUDI ルート CA 証明書：SUDI ルート CA 証明書と他の証明書および（セキュア ZTP の場合は）OV を同時にロードします。Cisco SUDI ルート証明書は、「Cisco PKI: Policies, Certificates, and Documents」ページ（https://www.cisco.com/security/pki/policies/index.html）からダウンロードできます。

以降の項に、ZTP オンボーディングモードを使用してデバイスを設定する際に使用するカスタム設定ファイルを準備するためのガイドラインを示します。

• 設定例ファイルのダウンロード

• 設定ファイルのプレビュー

• 設定ファイルでのデフォルトの置換可能パラメータの使用

• 設定ファイルでのカスタム置換可能パラメータの使用

• ZTP 設定スクリプトの例

セキュア ZTP では、オンボーディング時に最大 3 つの設定ファイルを適用できます。1 つは事前設定の準備用、2 つ目は Day 0 設定またはメイン設定、3 つ目は Day 0 設定後に適用される設定後ファイルです。Day 0 設定のみが必須です。アプリケーションの順序は固定されています。

設定例ファイルのダウンロード

設定コードの内容は、使用するデバイスと組織での使用方法によって大きく異なります。したがって、このドキュメントでは使用可能なすべてのオプションを完全には説明していません。

覚えておくべき主なガイドラインは次のとおりです。

1. カスタム設定コードは、デフォルトとカスタムの両方の置換可能（または「プレースホルダ」）パラメータを使用できます。これにより、デバイスエントリを一括でインポートするとき、または一度に 1 つずつ作成するときに、[設定属性（Configuration Attributes）] フ ィールドを使用してランタイム時に値を挿入できます。

2. 必要に応じて、新しいカスタム置換可能パラメータを作成できます。デフォルトのパラメータと同じ名前を使用せず、変数の命名規則に従っていれば、任意の名前を付けることができます。デフォルトの置換可能パラメータを使用する場合、それらのランタイム値は、デバイスエントリの [設定属性（Configuration Attributes）] フィールドで設定した値の代わりに、設定ファイルでのデフォルトの置換可能パラメータの使用に記載されているソースから挿入されます。

3. 置換可能パラメータの名前は大文字と小文字が区別され、中カッコとドル記号を含める必要があります。スペースを含めることはできません（代わりにアンダースコアを使用）。

4. すべてのカスタム置換可能パラメータのランタイム値が [設定属性（Configuration Attributes）] フィールドに指定されていることを確認します。ランタイム値を指定しなかったカスタム置換可能パラメータが 1 つでもある場合は、デバイス設定プロセスが失敗します。

5. セキュア ZTP を使用している場合は、Day 0 設定にのみカスタム置換可能パラメータを使用できます。カスタム置換可能パラメータは、事前設定ファイルと設定後ファイルではサポートされていません。

6. 一部のタスクを実行するには、Cisco Crosswork の API コールを使用する必要があります。特に、デバイスが 1 つの ZTP 状態から別の状態に移行したときに、コードで API コールを使用して Cisco Crosswork サーバーに通知する必要があります。

7. どの設定ファイルでも別の設定ファイルをコールして実行できますが（デバイスに正常にダウンロードできる場合）、セキュア ZTP でのみ、初期のセキュアなダウンロードの一環として個別の事前設定ファイル、設定後ファイル、および Day 0 設定ファイルを指定できます。

8. 設定ファイル名に複数のピリオドを含めることはできず、また、スペースの代わりにアンダースコアを使用する必要があります。その他のファイルの制限は、以下で説明する設定例ファイルに記載されています。

設定パラメータと API コールの使用方法の例については、Cisco Crosswork ZTP アプリケーションに付属の Cisco IOS-XR デバイスの ZTP 設定例ファイルを参照してください。Cisco Crosswork から ZTP 設定例ファイルをダウンロードするには、[デバイス管理（Device Management）] > [ZTP 設定ファイル（ZTP Configuration Files）] を選択し、[サンプルスクリプトのダウンロード（XR）（Download Sample Script (XR)）] をクリックします。設定スクリプトの例にはコメントが付けられており、一般的に使用される API とパラメータの例が示されています。

置換可能パラメータの詳細については、「設定ファイルでのデフォルトの置換可能パラメータの使用」と「設定ファイルでのカスタム置換可能パラメータの使用」を参照してください。

API コールの詳細については、Cisco Crosswork の Cisco Developer Network（DevNet）サイトで利用可能な「Crosswork API References」メニューの ZTP デバイスと設定 API に関する項を参照してください。このトピックの設定スクリプトの例には、関連する Crosswork API の使用例も示されています。

設定ファイルのプレビュー

以前に Cisco Crosswork にアップロードされた設定ファイルの内容をプレビューするには、[デバイス管理（Device Management）] > [ZTP 設定ファイル（ZTP Configuration Files）] を選択し、設定ファイル名をクリックします。ポップアッププレビューには、次の表に示すように、重要なコード機能のコードシンタックスのスタイルが含まれています。

設定ファイルでのデフォルトの置換可能パラメータの使用

次の表に、カスタム設定ファイルで使用できるデフォルトの置換可能パラメータを示します。実行時に、これらの各プレースホルダを Cisco Crosswork は各デバイスの適切な値に置き換えます。これらのプレースホルダの使用例については、Cisco Crosswork から設定スクリプトの例をダウンロードしてください（[デバイス管理（Device Management）] > [ZTP 設定ファイル（ZTP Configuration Files）] > [サンプルスクリプトのダウンロード（XR）（Download Sample Script (XR)）]）。これらのデフォルトの置換可能パラメータの使用方法を示す例については、「ZTP 設定スクリプトの例」を参照してください。

設定ファイルでのカスタム置換可能パラメータの使用

次の例に示すように、独自のカスタム置換可能パラメータを設定ファイルに作成できます。この例に示すように、同じ設定ファイル内でカスタムとデフォルトの置換可能パラメータを使用できます。

次の条件を満たしている限り、任意の名前をカスタム置換可能パラメータに割り当てることができます。

• 指定された変数定義形式（{$MyParm} など）に従う。

• パラメータ名のスペースをアンダーライン文字に置き換える。

• デフォルトの置換可能パラメータと同じ名前や大文字を再使用しない。

• デバイスエントリファイルの [設定属性（Configuration Attributes）] フィールドに、各カスタムパラメータの値を入力する。次の CLI 設定のサンプルファイルとそのカスタムパラメータを ZTP デバイスエントリファイルで使用するには、ZTP デバイスエントリファイルの各デバイスの [設定属性（Configuration Attributes）] フィールドで {$LOOPBACK0_IP} カスタムパラメータの値を指定する必要があります。カスタムパラメータの値を指定し忘れた場合は、設定が失敗します。

セキュア ZTP を使用している場合は、Day 0 設定ファイルのみでカスタム置換可能パラメータがサポートされます。

このスクリプトの例の最初の行は、IOS-XR デバイスの CLI スクリプトで必要です。これにより、ZTP はファイルが CLI スクリプトか bash/Python スクリプトかを確認できます。必要に応じてバージョン番号を更新してください。IOS-XE デバイスの場合、このような行は必要ありません。

!! IOS XR Configuration 7.3.1
!
hostname {$HOSTNAME}
username {$SSH_USERNAME}
 group root-lr
 group cisco-support
 password 0 {$SSH_PASSWORD}
!
cdp
!
line console
exec-timeout 0 0
!
line default
exec-timeout 0 0
session-timeout 120
!

call-home
 service active
 contact smart-licensing
 profile CiscoTAC-1
  active
  destination transport-method http
 !
!
interface Loopback0
 ipv4 address {$LOOPBACK0_IP} 255.255.255.255
!
interface MgmtEth0/RP0/CPU0/0
 description OOB Management ZTP
 ipv4 address {$IP_ADDRESS}
!     
end

ZTP 設定スクリプトの例

次に、テスト済みでコメントが付けられている設定ファイルの例が含まれているサンプルを示します。

#!/bin/bash

#################################################################################
#
# ztpSampleScriptFile.sh
#
# Purpose: This sample script is required to notify Crosswork of the status of
# ZTP processing on an IOS XR device, and to update the device's IP address and
# hostname in Crosswork. It is also used to download a day0 config file from
# Crosswork config repository and apply this initial configuration to the device.
#
# To use: Modify the sample script as needed, following the comment guidance.
# Then upload the modified script to the Crosswork config repository.
# Next, copy the URL of this file from the repository and set that
# value in the DHCP server boot filename for ZTP config download. When ZTP is
# triggered on the device, it will download and run the script, then notify
# Crosswork.
#
# Replace the following variables with valid values & upload to Crosswork config
# repository. Sample values are provided for reference.
# - XRZTP_INTERFACE_NAME: e.g., MgmtEth0/RP0/CPU0/0 interface where ZTP triggered
# - CW_HOST_IP: Crosswork VM management or data network IP address,
# - CW_PORT: 30604 for HTTP & 30603 only for HTTPS download of config file
# - CW_CONFIG_UUID: Replace with UUID of day0 config file from Crosswork repo,
#   assuming user has already uploaded device day-0 config file.
#
# This script has been tested and is known to work on Cisco NCS5501, NCS540l,
# ASR9901, and 8800 routers.
#
#################################################################################


export LOGFILE=/disk0:/ztp/customer/user-script.log

XRZTP_INTERFACE_NAME="MgmtEth0/RP0/CPU0/0"
# ZTP helper library is assumed to be installed in IOS-XR linux shell
source /pkg/bin/ztp_helper.sh
interfacedata=$(xrcmd "show interface ${XRZTP_INTERFACE_NAME}")

CW_HOST_IP="192.168.100.248"
CW_PORT="30604"
CW_CONFIG_UUID="e04661f8-0169-4ad3-82b8-a7c26c4f2565"

# Send logging information to log file on device disk0:/ztp/user-script.log
function ztp_log() {

    echo "$(date +"%b %d %H:%M:%S") "$1 >> $LOGFILE
}

#
# Get chassis serial number of the device, required by ZTP process.
# This works on Cisco NCS5501, NCS540l, 8800 series routers.
#
function get_serialkey(){

    local sn=$(dmidecode | grep -m 1 "Serial Number:" | awk '{print $NF}');
    if [ "$sn" != "Not found" ]; then
           ztp_log "Serial $sn found.";
           # The value of $sn from dmidecode should be same as serial number
           # of XR device chassis.
           DEVNAME=$sn;
           return 0
    else
        ztp_log "Serial $sn not found.";
        return 1
    fi
}

#
# Get chassis serial number of the device, required by ZTP process.
# This is tested and works on Cisco ASR 9901, but not other devices.
#
function get_serialkey_asr9901(){

     udi=$(xrcmd "show license udi")
     sn="$(cut -d':' -f4 <<<"$udi")"
     pid="$(cut -d':' -f3 <<<"$udi")"
     pid="$(cut -d',' -f1 <<<"$pid")"
     echo "Serial Number $sn"
     echo "product id $pid"
}

#
# Get IP address and subnet mask from device. IP address is assigned from DHCP
# server on interface where ZTP was triggered.
#
function get_ipaddress(){

    local ipvar=($(echo $interfacedata | awk -F "Internet address is " '{sub(/ .*/,"",$2);print $2}'));
    local ipv4addr=$(xrcmd "sh run interface ${XRZTP_INTERFACE_NAME} | i ipv4 address" | awk '{print $3}')
    local ipv6addr=$(xrcmd "sh run interface ${XRZTP_INTERFACE_NAME} | i ipv6 address" | awk '{print $3}')
    local ipaddress=($(echo $ipvar | awk -F "/" '{sub(/ .*/,"",$1);print $1}'));
    local mask=($(echo $ipvar | awk -F "/" '{sub(/ .*/,"",$2);print $2}'));
    local maskv6=($(echo $ipv6addr | awk -F "/" '{sub(/ .*/,"",$2);print $2}'));

    ztp_log "### Value of interfacedata => $interfacedata ###"
    ztp_log "### Value of ipvar => $ipvar ###"
    ztp_log "#####IPv4 address $ipaddress and mask $mask found. #####";

    IPADDR=$ipaddress
    MASK=$mask
    MASKV6=$maskv6

    return 0
}

#
# Fetch hostname from device configuration.
#
function get_hostname(){

    hostnamedata=$(xrcmd "show running-config hostname")
    local hostname=($(echo $hostnamedata | awk -F "hostname " '{sub(/ .*/,"",$2);print $2}'));

    ztp_log "#####hostname $hostname found.";
    HOSTNAME=$hostname;
    return 0;
}

#
# Download day-0 config file from Crosswork config repository using values
# set for CW_HOST_IP, CW_PORT and CW_CONFIG_UUID.
# The MESSAGE variable is optional, can be used to display a suitable message
# based on the ZTP success/failure log.
#
function download_config(){

    ztp_log "### Downloading system configuration ::: ${DEVNAME} ###";
    ztp_log "### ip address passed value ::: ${IPADDR} ###";
    ip netns exec global-vrf /usr/bin/curl -k --connect-timeout 60 -L -v --max-filesize 104857600 http://${CW_HOST_IP}:${CW_PORT}/crosswork/configsvc/v1/configs/device/files/${CW_CONFIG_UUID} -H X-cisco-serial*:${DEVNAME} -H X-cisco-arch*:x86_64 -H X-cisco-uuid*: -H X-cisco-oper*:exr-config -o /disk0:/ztp/customer/downloaded-config 2>&1

    if [[ "$?" != 0 ]]; then
        STATUS="ProvisioningError"
        ztp_log "### status::: ${STATUS} ###"
        ztp_log "### Error downloading system configuration, please review the log ###"
        MESSAGE="Error downloading system configuration"
    else
        STATUS="Provisioned"
        ztp_log "### status::: ${STATUS} ###"
        ztp_log "### Downloading system configuration complete ###"
        MESSAGE="Downloading system configuration complete"
    fi
}

#
# Apply downloaded configuration to the device and derive ZTP status based on
# success/failure of ZTP process. The MESSAGE variable is optional, can be used
# to display a suitable message based on the ZTP success/failure log.
#
function apply_config(){
    ztp_log "### Applying initial system configuration ###";
    xrapply_with_reason "Initial ZTP configuration" /disk0:/ztp/customer/downloaded-config 2>&1 >> $LOGFILE;
    ztp_log "### Checking for errors ###";
    local config_status=$(xrcmd "show configuration failed");
    if [[ $config_status ]]; then
        echo $config_status  >> $LOGFILE
        STATUS="ProvisioningError"
        ztp_log "### status::: ${STATUS} ###"
        ztp_log "!!! Error encountered applying configuration file, please review the log !!!!";
        MESSAGE="Error encountered applying configuration file, ZTP process failed"
    else
       STATUS="Provisioned"
       ztp_log "### status::: ${STATUS} ###"
       ztp_log "### Applying system configuration complete ###";
       MESSAGE="Applying system configuration complete, ZTP process completed"
   fi
}

#
# Call Crosswork ZTP API to update device ZTP status, IP address, hostname.
# Without this function, device status will remain in "In Progress" and not
# be updated in Crosswork.
#
# Using this API, device SSH/SNMP connectivity details can also be updated.
# Values for connectivity details values can be added as part of
# "connectivityDetails" array in below curl command. Sample snippet provided:
#
#   "connectivityDetails": [{
#     "protocol": "SSH",
#     "inetAddr": [{
#       "inetAddressFamily": "IPV4/IPV6",
#       "ipaddrs": "<ssh/snmp ipaddress>",
#       "mask": <ipaddress mask(Integer).>,
#       "type": "CONNECTIVITYINFO"
#     }],
#     "port": <ssh/snmp port(Integer)>,
#     "timeout": <ssh/snmp timeout(Integer). default to 60sec>
#   }]
#
function update_device_status() {

     echo "'"$IPADDR"'"
     echo "'"$MASK"'"
     echo "'"$DEVNAME"'"
     echo "'"$STATUS"'"
     echo "'"$HOSTNAME"'"
     echo "'"$MESSAGE"'"


    curl -d '{
       "ipAddress":{
            "inetAddressFamily": "IPV4",
            "ipaddrs": "'"$IPADDR"'",
            "mask":  '$MASK'
        },
       "serialNumber":"'"$DEVNAME"'",
       "status":"'"$STATUS"'",
       "hostName":"'"$HOSTNAME"'",
       "message":"'"$MESSAGE"'"
   }' -H "Content-Type: application/json" -X PATCH http://${CW_HOST_IP}:${CW_PORT}/crosswork/ztp/v1/deviceinfo/status
}


# ==== Script entry point ====
STATUS="InProgress"
get_serialkey;
#get_serialkey_asr9901; // For Cisco ASR9901, replace get_serialkey with get_serialkey_asr9901.
ztp_log "Hello from ${DEVNAME} !!!";
get_ipaddress;
ztp_log "Starting autoprovision process...";
download_config;
apply_config;
get_hostname;
update_device_status;

ztp_log "Autoprovision complete...";
exit 0

#!/bin/bash

#################################################################################
#
# Secure ZTP post-configuration script. It updates the hostname and
# ipaddress for the device input, serial key and Crosswork host and port
#
#################################################################################


export LOGFILE=/disk0:/ztp/customer/user-script.log

XRZTP_INTERFACE_NAME="MgmtEth0/RP0/CPU0/0"
# ZTP helper library is assumed to be installed in IOS-XR linux shell
source /pkg/bin/ztp_helper.sh
interfacedata=$(xrcmd "show interface ${XRZTP_INTERFACE_NAME}")

CW_HOST_IP="192.168.100.248"   #update from the post script prepare code
CW_PORT="30603"           #update from the post script prepare code


# Send logging information to log file on device disk0:/ztp/user-script.log
function ztp_log() {

    echo "$(date +"%b %d %H:%M:%S") "$1 >> $LOGFILE
}


#
# Get IP address and subnet mask from device. IP address is assigned from DHCP
# server on interface where ZTP was triggered.
#
function get_ipaddress(){

    local ipvar=($(echo $interfacedata | awk -F "Internet address is " '{sub(/ .*/,"",$2);print $2}'));
    local ipv4addr=$(xrcmd "sh run interface ${XRZTP_INTERFACE_NAME} | i ipv4 address" | awk '{print $3}')
    local ipv6addr=$(xrcmd "sh run interface ${XRZTP_INTERFACE_NAME} | i ipv6 address" | awk '{print $3}')
    local ipaddress=($(echo $ipvar | awk -F "/" '{sub(/ .*/,"",$1);print $1}'));
    local mask=($(echo $ipvar | awk -F "/" '{sub(/ .*/,"",$2);print $2}'));
    local maskv6=($(echo $ipv6addr | awk -F "/" '{sub(/ .*/,"",$2);print $2}'));

    ztp_log "### Value of interfacedata => $interfacedata ###"
    ztp_log "### Value of ipvar => $ipvar ###"
    ztp_log "#####IPv4 address $ipaddress and mask $mask found. #####";

    IPADDR=$ipaddress
    MASK=$mask
    MASKV6=$maskv6

    return 0
}

#
# Fetch hostname from device configuration.
#
function get_hostname(){

    hostnamedata=$(xrcmd "show running-config hostname")
    local hostname=($(echo $hostnamedata | awk -F "hostname " '{sub(/ .*/,"",$2);print $2}'));

    ztp_log "#####hostname $hostname found.";
    HOSTNAME=$hostname;
    return 0;
}



#
# Call Crosswork ZTP API to update device ZTP status, IP address, hostname.
# Without this function, device status will remain in "In Progress" and not
# be updated in Crosswork.
#
# Using this API, device SSH/SNMP connectivity details can also be updated.
# Values for connectivity details values can be added as part of
# "connectivityDetails" array in below curl command. Sample snippet provided:
#
#   "connectivityDetails": [{
#     "protocol": "SSH",
#     "inetAddr": [{
#       "inetAddressFamily": "IPV4/IPV6",
#       "ipaddrs": "<ssh/snmp ipaddress>",
#       "mask": <ipaddress mask(Integer).>,
#       "type": "CONNECTIVITYINFO"
#     }],
#     "port": <ssh/snmp port(Integer)>,
#     "timeout": <ssh/snmp timeout(Integer). default to 60sec>
#   }]
#
function update_device_status() {

     echo "'"$IPADDR"'"
     echo "'"$MASK"'"
     echo "'"$SERIAL_KEY"'"
     echo "'"$HOSTNAME"'"


    curl -d '{
       "ipAddress":{
            "inetAddressFamily": "IPV4",
            "ipaddrs": "'"$IPADDR"'",
            "mask":  '$MASK'
        },
       "serialNumber":"'"$SERIAL_KEY"'",
       "hostName":"'"$HOSTNAME"'",
       "message":"Post config script updated succssfully"
   }' -H "Content-Type: application/json" -X PATCH http://${CW_HOST_IP}:${CW_PORT}/crosswork/ztp/v1/deviceinfo/status
}

function get_sudi_serial() {
   local rp_card_num=`ip netns exec xrnns /pkg/bin/show_platform_sysdb | grep Active  | cut -d ' ' -f 1`
   echo $rp_card_num
   xrcmd "show platform security tam all location $rp_card_num" > tamfile.txt
   local sudi_serial=$(sed -n -e '/Device Serial Number/ s/.*\- *//p' tamfile.txt)
   echo $sudi_serial
   SERIAL_KEY=$sudi_serial
   return 0
}

function ztp_disable()
{
	xrcmd "ztp disable noprompt"
}

function ztp_enable()
{
	xrcmd "ztp enable noprompt"
}

# ==== Script entry point ====
get_sudi_serial;
ztp_log "Hello from ${SERIAL_KEY} !!!";
get_ipaddress;
get_hostname;
update_device_status;

ztp_log "Autoprovision complete...";
ztp_log "Disabling secure mod"
ztp_disable;
exit 0

Cisco Crosswork は、ZTP デバイスエントリを使用して、プロビジョニングするデバイスの IP アドレス、プロトコル、およびその他の情報を事前に指定できます。Cisco Crosswork は、ZTP 処理が正常に完了すると、これらのインポートされたエントリに詳細情報を入力します。

デバイスエントリの CSV ファイルをインポートすることで、ZTP デバイスエントリを一括で作成できます。

次のトピックでは、デバイスエントリの CSV ファイルのテンプレートをダウンロードし、適切な形式の ZTP デバイスエントリを作成する方法について説明します。

慣れるまでは、デバイスエントリの CSV ファイル形式を試すことをお勧めします。テンプレートのコピーに 1 つまたは 2 つのデバイスエントリのみを追加し、インポートします。その後で、必要な結果を取得する方法を確認できます。

また、単一 ZTP デバイスエントリの作成で説明するように、Cisco Crosswork の UI を使用して、ZTP デバイスエントリを 1 つずつ作成することもできます。

ZTP デバイス エントリ テンプレートのダウンロードと編集

1. メインメニューから [デバイス管理（Device Management）] > [デバイス（Devices）] を選択します。

2. [ゼロタッチデバイス（Zero Touch Devices）] タブをクリックします。

3. をクリックします。

4. [「devices import」テンプレート（.csv）のダウンロード（Download 'devices import' template (.csv)）] リンクをクリックし、[保存（Save）] をクリックしてローカルストレージリソースに保存します。[キャンセル（Cancel）] をクリックしてダイアログボックスをクリアします。

5. 選択したアプリケーションで CSV テンプレートを開き、新しい名前で保存します。各行で、ZTP を使用してオンボーディングする予定の各デバイスのエントリを作成します。各列に入力する値については、次のトピックの項を参照してください。

ZTP デバイスエントリの CSV テンプレートリファレンス

次の表で、テンプレート内の列の使用方法について説明します。エントリを必要とする列については、列名の横にアスタリスク（*）を付けて示しています。

4 つの [接続（Connectivity）] 列では複数のエントリが許可されているため、1 台のデバイスに複数の接続プロトコルを指定できます。このオプションを使用する場合は、エントリ間にセミコロンを使用し、次の 3 つの列に同じ順序で値を入力します。たとえば、[接続プロトコル（Connectivity Protocol）] 列に SSH;NETCONF; と入力するとします。[接続ポート（Connectivity Port）] 列に 23;830; と入力した場合、2 つの列のエントリは次のようにマッピングされます。

• SSH：22

• NETCONF：830

Crosswork 接続プロトコルの要件

Cisco Crosswork アプリケーションでは、デバイスごとにさまざまな接続プロトコルを有効にする必要があります。次の表に、サポートされる各接続プロトコルのこれらの要件を示します。この表に示されているアプリケーションを使用する場合は、デバイスでこれらのプロトコルを有効にしてください。オンボーディングするには、各デバイスでこれらのプロトコルの少なくとも 1 つを有効にする必要があります。これらのプロトコルが 1 つもなければ、デバイスをオンボーディングできません。

Cisco Crosswork ZTP の目的は、新しいデバイスのエキスパートを現場に配置することなく、新しいデバイスを迅速かつ簡単にオンボーディングすることです。ZTP は、そのタスクの一部としてイメージ化と設定を実行し、デバイス設定の一部としてスクリプトを実行します。ただし、汎用のデバイス設定ユーティリティとして設計されていないため、このような使い方はしないでください。

ZTP を使用してオンボーディングしたデバイスを再設定する必要がある場合は、次を使用します。

• Cisco Crosswork Change Automation Playbook。オンデマンドでデバイスに設定変更を展開できます。

• Cisco Network Services Orchestrator（Cisco NSO）または使用している Cisco Crosswork の他のプロバイダの設定変更機能。

• デバイスとデバイスの OS コマンド ライン インターフェイスへの直接接続。

これらの方法のいずれも使用できない場合は、デバイスを削除するのが最善の方法です。正しい設定を使用すれば、デバイスを再度オンボーディングできます。

ZTP デバイスを削除するには、[デバイス管理（Device Management）] > [デバイス（Devices）] > [ゼロタッチデバイス（Zero Touch Devices）] を選択し、テーブル内のデバイスを選択して をクリックします。

ZTP を使用してオンボーディングされたシスコのデバイスの廃止が必要な場合があります。デバイスライセンスは、オンボーディング時に入力したデバイスのシリアル番号に関連付けられます。ZTP では、1 台のデバイスを最大 3 つの異なるシリアル番号に関連付けることができます。この事実を使用して、ネットワークと Cisco Crosswork インベントリから障害が発生したデバイスまたは古いデバイスを削除できます。追加のライセンスを消費することなく、後で置き換えることができます。

このルールは、シャーシを備えたデバイスだけでなく、ラインカードやその他の着脱可能なデバイスモジュールにも適用されます。これらの各モジュールには、独自のシリアル番号があります。モジュールの RMA が必要な場合は、古いライセンスを新しいモジュールのシリアル番号に関連付けます。ただし、次の手順に従って、インベントリから古いラインカードとそのシリアル番号を削除します。

1. [デバイス管理（Device Management）] > [デバイス（Devices）] > [ゼロタッチデバイス（Zero Touch Devices）] を選択します。

2. テーブルで古いデバイスを見つけ、そのシリアル番号を記録します。

3. デバイスを選択し、 をクリックして削除します。

   デバイスを削除した後も、Cisco Crosswork はこのシリアル番号に関連付けられたライセンスを消費済みとしてカウントします。新しいデバイスまたは RMA 交換デバイスの購入の一部としてこのライセンスを追跡し、アクティブな使用のために古いデバイスのライセンスを戻すことができます。

   Cisco Crosswork では、同じライセンスを持つアクティブなデバイスを 2 台設定することはできません。新しいデバイスまたは交換用デバイスをオンボーディングする前に、古いデバイスを削除する必要があります。

4. 新しいデバイスをオンボーディングする場合は、次の手順を実行します。

   1. 新しいデバイスの ZTP デバイスエントリを作成する場合は、新しいシリアル番号と古いシリアル番号の両方を入力します。

   2. セキュア ZTP を使用している場合は、新しいデバイスの所有権バウチャー要求とともに、古いデバイスと新しいデバイスの両方のシリアル番号を送信します。シスコは、再生成された所有権バウチャーの使用中のライセンスに、古いシリアル番号と新しいシリアル番号を関連付けます。

   3. 他の ZTP デバイスと同様に、新しいデバイスをオンボーディングします。古いデバイスライセンスのみが使用されます。

ZTP によるデバイスのオンボーディングが完了したら、アセンブルした ZTP アセットの一部のオフラインコピーを削除できます。組織のポリシーとベストプラクティスに応じて、他のユーザーを保持します。推奨事項：

• [ZTP プロファイル（ZTP profiles）]：通常は、オンボーディングの完了後に ZTP プロファイルを削除しても安全です。ZTP プロファイルを削除するには、[デバイス管理（Device Management）] > [ゼロタッチプロファイル（Zero Touch Profiles）] を選択します。削除する ZTP プロファイルを表すタイルで、 をクリックし、ドロップダウンメニューから [削除（Delete）] を選択します。

• [ZTP デバイスエントリ CSV ファイル（ZTP device entry CSV file）]：このファイルのオフラインコピーを保持してテンプレートとして使用することができます。このファイルは、同じネットワークアーキテクチャとデバイスタイプを共有するブランチオフィスが多数ある場合に便利です。それ以外の場合は、ファイルシステムから削除できます。CSV ファイルテンプレートはいつでもダウンロードできます。オンボーディング後に入力したデータを含む、ZTP デバイスのすべてのデータが含まれているバックアップ CSV ファイルをエクスポートすると便利な場合があります。CSV デバイスのバックアップをエクスポートするには、[デバイス管理（Device Management Devices）] > [デバイス（Devices）] > [ゼロタッチデバイス（Zero Touch Devices）] を選択します。次に、 をクリックして CSV ファイルを保存します。

• [ソフトウェアイメージと SMU（Software images and SMUs）]：これらのファイルの実稼働バージョンをオフラインで保存し、組織のポリシーに従って古いバージョンを削除します。同じファミリの複数のデバイスをイメージ化するために使用する場合は、アップロードしたイメージファイルを Cisco Crosswork から削除しないでください。古いイメージを削除するには、[デバイス管理（Device Management）] > [ソフトウェアイメージ（Software Images）] を選択し、テーブル内のファイルを選択して、 をクリックします。

• [設定ファイル（Configuration files）]：すでに Cisco Crosswork にアップロードしている設定を保持する必要はありませんが、組織のポリシーが異なる場合があります。ZTP を使用して同じファミリのデバイスをさらに設定する場合は、アップロードした設定ファイルを削除しないでください。設定が変更された場合は、保存されているバージョンを簡単に更新できます。新しい設定ファイルまたはスクリプトを作成し、[デバイス管理（Device Management）] > [設定ファイル（Configuration Files）] を選択し、テーブル内のファイルを選択して、 をクリックします。次に、作成した新しいスクリプトファイルを参照し、新しい設定をコピーして貼り付けることができます。設定が古くなった場合は削除します。[デバイス管理（Device Management）] > [設定ファイル（Configuration Files）] を選択し、テーブル内のファイルを選択して、 をクリックします。

• [クレデンシャルプロファイル（Credential profiles）]：インポートしたクレデンシャルプロファイルの CSV ファイルはすぐに削除できます。アップロードされているクレデンシャルプロファイルは削除しないでください。ユーザー名とパスワードを変更した場合は、クレデンシャルプロファイルを更新します。[デバイス管理（Device Management）] > [クレデンシャル（Credentials）] を選択し、テーブル内のクレデンシャルプロファイルを選択して、 をクリックします。

Cisco Crosswork ZTP のプロビジョニングとオンボーディングは迅速かつ自動的に行われますが、エラーや問題が発生します。次のトピックでは、一般的な問題を解決する方法について説明します。

Cisco Crosswork ZTP を使用してオンボーディングできるサードパーティ製デバイスは、セキュア ZTP RFC に 100% 準拠しているサードパーティ製デバイスのみです。

ステータスエラーの検査

[ゼロタッチデバイス（Zero Touch Devices）] ウィンドウの [ステータス（Status）] 列には、ZTP 処理が [プロビジョニングエラー（Provisioning Error）]、[オンボーディングエラー（Onboarding Error）]、または（セキュア ZTP の場合のみ）[ZTP エラー（ZTP Error）] で終了したすべてのデバイスエントリの横に が表示されます。 をクリックすると、エラーに関する情報を示すポップアップウィンドウが表示されます。次に例を示します。ポップアップウィンドウの表示が終了したら、 をクリックして閉じます。

イメージファイルのアップロード時のエラー

ファイルの MD5 チェックサムが正しいことを確認します。ファイル情報が正しい場合でも、ネットワーク接続が遅いためにイメージのアップロードが失敗する可能性があります。この問題が発生している場合は、アップロードを再試行します。

ZTP デバイスエントリまたは ZTP プロファイルの作成時に、アップロードされたイメージと設定ファイルがドロップダウンメニューに表示されない

ドロップダウンメニューでは、デバイスエントリまたは ZTP プロファイルで指定したデバイスファミリとリリース番号に基づいてイメージと設定ファイルを選択します。ファイル情報が、使用しているデバイスエントリまたはプロファイルの情報と一致していることを確認します。

デバイスのインポート時のエラー

インベントリ内のデバイスにインポートするデバイスと同じシリアル番号がある場合は、インポートする前にデバイスが [プロビジョニングなし（Unprovisioned）] 状態であることを確認します。CSV フ ァイルを使用してインポートしたすべてのデバイスのステータスは、インポート時に [プロビジョニングなし（Unprovisioned）] に設定されます。インポートする前に、CSV ファイルに記載されている設定、イメージ、および ZTP プロファイルが存在することを確認します。デバイスの CSV ファイルをエクスポートし、変更を加えて再インポートすることで、デバイスイメージファイルと設定ファイルを編集できます。この編集方法を使用する場合は、インポート前に CSV ファイルに正しい UUID があることを確認します。

イメージファイルのダウンロードに失敗した

Cisco Crosswork とデバイス間にネットワーク接続があることを確認します。デバイスが IP アドレスを DHCP サーバーから取得していることを確認します。DHCP サーバーの設定ファイルで指定されたソフトウェアイメージの UUID が正しいことを確認します。設定ファイルで指定されたイメージ UUID を修正する必要がある場合は、ZTP 処理を再度開始する前に DHCP サーバーを再起動してください。

設定ファイルのダウンロードに失敗した

Cisco Crosswork とデバイス間にネットワーク接続があることを確認します。デバイスが IP アドレスを DHCP サーバーから取得していることを確認します。DHCP サーバーの設定ファイルで指定されたソフトウェアイメージの UUID が正しいことを確認します。DHCP 設定ファイルで指定されたイメージ UUID を修正する必要がある場合は、ZTP 処理を再度開始する前に DHCP サーバーを再起動してください。デバイスのシリアル番号がデバイスのシャーシのシリアル番号と一致していることを確認します。ZTP 処理を開始する前に、デバイスのステータスが [プロビジョニングなし（Unprovisioned）] か、または [進行中（In Progress）] であることを確認します。デバイスが他の状態である限り、設定のダウンロードは失敗し続けます。

デバイスの状態が [オンボーディング済み（Onboarded）] と表示され、[プロビジョニング済み（Provisioned）] と表示されない

[プロビジョニング済み（Provisioned）] は、ZTP 処理の中間状態です。デバイスの状態が [プロビジョニング済み（Provisioned）] に変わると、Cisco Crosswork はすぐにデバイスのオンボーディングを試みます。ステータスが [オンボーディング済み（Onboarded）] か、または [オンボーディングエラー（Onboarding Error）] に変わります。

オンボーディングエラー

デバイスを一意に識別するためのデフォルトの Cisco Crosswork デバイスライフサイクル管理（DLM）ポリシーは、IP アドレスです。既存のデバイスと一致する IP アドレスを持つ新しいデバイスをインポートすると、デバイスのステータスが [プロビジョニング済み（Provisioned）] に変わり、その後、[オンボーディングエラー（Onboarding Error）] に変わります。新しいデバイスの IP アドレスが空白の場合、同じ結果が得られます。インストールで OSPF ID、ISIS ID、またはその他の DLM ポリシーを使用してデバイス ID を決定する場合も、同じ問題が発生します。オンボーディングは、すべての DLM ポリシーフィールドに一意の空白以外の値を入力した場合にのみ成功します。オンボーディングが失敗した場合は、ポップアップエラーメッセージを調べて、対応するフィールドを更新し、オンボーディングを再試行します。