Konfigurasikan sumber OPC-UA (CLI) - AWS IoT SiteWise
Sintaksis PermintaanIsi permintaanContoh-contoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Konfigurasikan sumber OPC-UA (CLI)

Anda dapat menentukan sumber data OPC-UA untuk gateway SiteWise Edge menggunakan file. AWS CLI Untuk melakukan ini, buat file JSON konfigurasi kemampuan OPC-UA dan gunakan update-gateway-capability-configurationperintah untuk memperbarui konfigurasi gateway SiteWise Edge. Anda harus menentukan semua sumber OPC-UA Anda dalam satu konfigurasi kemampuan.

Untuk informasi lebih lanjut tentang mendefinisikan sumber dengan AWS Command Line Interface, lihatMengkonfigurasi sumber data ()AWS CLI.

Kemampuan ini memiliki versi berikut.

Versi Namespace
1 iotsitewise:opcuacollector:1

Sintaksis Permintaan

{
  "sources": [
    {
      "name": "string",
      "endpoint": {
        "certificateTrust": {
          "type": "string"
          "certificateBody": "string"
          "certificateChain": "string"
        },
        "endpointUri": "string",
        "securityPolicy": "string",
        "messageSecurityMode": "string",
        "identityProvider": {
          "type": "string",
          "usernameSecretArn": "string"
        },
        "nodeFilterRules": [
          {
            "action": "string",
            "definition": {
              "type": "string",
              "rootPath": "string"
            }
          }
        ]
      },
      "measurementDataStreamPrefix": "string"
      "propertyGroups": [
      {
          "name": "string",
          "deadband": {
              "type":"string",
              "value": string,
              "eguMin": string,
              "eguMax": string,
              "timeoutMilliseconds": string
          },
          "scanMode": {
              "type": "string",
              "rate": string
          },
          "nodeFilterRuleDefinitions": [
              {
                  "type": "string",
                  "rootPath": "string"
              }
          ]
      }
    }
  ]
}

Isi permintaan

sumber

Daftar struktur definisi sumber OPC-UA yang masing-masing berisi informasi berikut:

name

Nama yang unik dan ramah untuk sumbernya.

titik akhir

Struktur endpoint yang berisi informasi berikut:

CertificateTrust

Struktur kebijakan kepercayaan sertifikat yang berisi informasi berikut:

tipe

Mode kepercayaan sertifikat untuk sumbernya. Pilih salah satu cara berikut:

  • TrustAny— Gateway SiteWise Edge mempercayai sertifikat apa pun saat terhubung ke sumber OPC-UA.

  • X509— Gateway SiteWise Edge mempercayai sertifikat X.509 saat terhubung ke sumber OPC-UA. Jika Anda memilih opsi ini, Anda harus menentukan certificateBodycertificateTrust. Anda juga dapat menentukan certificateChain dalamcertificateTrust.

CertificateBody

(Opsional) Badan sertifikat X.509.

Bidang ini diperlukan jika Anda memilih X509 untuk type masukcertificateTrust.

CertificateChain

(Opsional) Rantai kepercayaan untuk sertifikat X.509.

Bidang ini hanya digunakan jika Anda memilih X509 untuk type masukcertificateTrust.

EndpoinTuri

Titik akhir lokal dari sumber OPC-UA. Misalnya, titik akhir lokal Anda mungkin terlihat sepertiopc.tcp://203.0.113.0:49320.

Kebijakan Keamanan

Kebijakan keamanan yang digunakan sehingga Anda dapat mengamankan pesan yang dibaca dari sumber OPC-UA. Pilih salah satu cara berikut:

  • NONE— Gateway SiteWise Edge tidak mengamankan pesan dari sumber OPC-UA. Kami menyarankan Anda memilih kebijakan keamanan yang berbeda. Jika Anda memilih opsi ini, Anda juga harus memilih NONE untukmessageSecurityMode.

  • BASIC256_SHA256- Kebijakan Basic256Sha256 keamanan.

  • AES128_SHA256_RSAOAEP- Kebijakan Aes128_Sha256_RsaOaep keamanan.

  • AES256_SHA256_RSAPSS- Kebijakan Aes256_Sha256_RsaPss keamanan.

  • BASIC128_RSA15— (Usang) Kebijakan Basic128Rsa15 keamanan tidak digunakan lagi dalam spesifikasi OPC-UA karena tidak lagi dianggap aman. Kami menyarankan Anda memilih kebijakan keamanan yang berbeda. Untuk informasi lebih lanjut, lihat Basic128Rsa15.

  • BASIC256— (Usang) Kebijakan Basic256 keamanan tidak digunakan lagi dalam spesifikasi OPC-UA karena tidak lagi dianggap aman. Kami menyarankan Anda memilih kebijakan keamanan yang berbeda. Untuk informasi lebih lanjut, lihat Basic256.

penting

Jika Anda memilih kebijakan keamanan selainNONE, Anda harus memilih SIGN atau SIGN_AND_ENCRYPT untukmessageSecurityMode. Anda juga harus mengonfigurasi server sumber Anda untuk mempercayai gateway SiteWise Edge. Untuk informasi selengkapnya, lihat Mengaktifkan server sumber OPC-UA Anda untuk mempercayai gateway Edge SiteWise .

messageSecurityMode

Mode keamanan pesan yang digunakan untuk mengamankan koneksi ke sumber OPC-UA. Pilih salah satu cara berikut:

  • NONE— Gateway SiteWise Edge tidak mengamankan koneksi ke sumber OPC-UA. Kami menyarankan Anda memilih mode keamanan pesan yang berbeda. Jika Anda memilih opsi ini, Anda juga harus memilih NONE untuksecurityPolicy.

  • SIGN— Data dalam perjalanan antara gateway SiteWise Edge dan sumber OPC-UA ditandatangani tetapi tidak dienkripsi.

  • SIGN_AND_ENCRYPT— Data dalam perjalanan antara gateway dan sumber OPC-UA ditandatangani dan dienkripsi.

penting

Jika Anda memilih mode keamanan pesan selainNONE, Anda harus memilih securityPolicy selainNONE. Anda juga harus mengonfigurasi server sumber Anda untuk mempercayai gateway SiteWise Edge. Untuk informasi selengkapnya, lihat Mengaktifkan server sumber OPC-UA Anda untuk mempercayai gateway Edge SiteWise .

Penyedia Identitas

Struktur penyedia identitas yang berisi informasi berikut:

tipe

Jenis kredensyal otentikasi yang diperlukan oleh sumber. Pilih salah satu cara berikut:

  • Anonymous— Sumber tidak memerlukan otentikasi untuk terhubung.

  • Username— Sumber membutuhkan nama pengguna dan kata sandi untuk terhubung. Jika Anda memilih opsi ini, Anda harus menentukan usernameSecretArnidentityProvider.

usernameSecretArn

(Opsional) ARN rahasia. AWS Secrets Manager Gateway SiteWise Edge menggunakan kredensyal otentikasi dalam rahasia ini ketika terhubung ke sumber ini. Anda harus melampirkan rahasia ke SiteWise konektor IoT gateway SiteWise Edge Anda untuk menggunakannya untuk otentikasi sumber. Untuk informasi selengkapnya, lihat Mengkonfigurasi otentikasi sumber data.

Bidang ini diperlukan jika Anda memilih Username untuk type masukidentityProvider.

nodeFilterRules

Daftar struktur aturan filter node yang menentukan jalur aliran data OPC-UA untuk dikirim ke Cloud. AWS Anda dapat menggunakan filter node untuk mengurangi waktu startup dan penggunaan CPU gateway SiteWise Edge Anda dengan hanya menyertakan jalur ke data yang Anda modelkan AWS IoT SiteWise. Secara default, gateway SiteWise Edge mengunggah semua jalur OPC-UA kecuali yang dimulai dengan. /Server/ Untuk menentukan filter node OPC-UA, Anda dapat menggunakan jalur node * dan ** karakter wildcard. Untuk informasi selengkapnya, lihat Menggunakan filter node OPC-UA.

Setiap struktur dalam daftar harus berisi informasi berikut:

aksi

Tindakan untuk aturan filter node ini. Anda dapat memilih opsi berikut:

  • INCLUDE— Gateway SiteWise Edge hanya mencakup aliran data yang cocok dengan aturan ini.

definisi

Struktur aturan filter node yang berisi informasi berikut:

tipe

Jenis jalur filter node untuk aturan ini. Anda dapat memilih opsi berikut:

  • OpcUaRootPath— Gateway SiteWise Edge mengevaluasi jalur filter node ini terhadap root hierarki jalur OPC-UA.

RootPath

Jalur filter node untuk mengevaluasi terhadap akar hierarki jalur OPC-UA. Jalan ini harus dimulai dengan/.

measurementDataStreamAwalan

Sebuah string untuk ditambahkan ke semua aliran data dari sumber. Gateway SiteWise Edge menambahkan awalan ini ke semua aliran data dari sumber ini. Gunakan awalan aliran data untuk membedakan antara aliran data yang memiliki nama yang sama dari sumber yang berbeda. Setiap aliran data harus memiliki nama unik dalam akun Anda.

PropertyGroups

(Opsional) Daftar grup properti yang menentukan deadband dan scanMode diminta oleh protokol.

name

Nama grup properti. Ini harus menjadi pengidentifikasi unik.

deadband

deadbandStruktur yang berisi informasi berikut:

tipe

Jenis deadband yang didukung. Nilai yang diterima adalah ABSOLUTE danPERCENT.

value

Nilai deadband. typeKapanABSOLUTE, nilai ini adalah ganda tanpa unit. typeKapanPERCENT, nilai ini adalah ganda antara 1 dan100.

eGUMin

(Opsional) Unit teknik minimum saat menggunakan PERCENT deadband. Anda mengatur ini jika server OPC-UA tidak memiliki unit teknik yang dikonfigurasi.

eGUMAX

(Opsional) Unit teknik maksimum saat menggunakan PERCENT deadband. Anda mengatur ini jika server OPC-UA tidak memiliki unit teknik yang dikonfigurasi.

TimeoutMilliseconds

Durasi dalam milidetik sebelum batas waktu. Minimal adalah100.

ScanMode

scanModeStruktur yang berisi informasi berikut:

tipe

Jenis yang didukung dariscanMode. Nilai yang diterima adalah POLL danEXCEPTION.

tingkat

Interval pengambilan sampel untuk mode pemindaian.

nodeFilterRuleDefinisi

(Opsional) Daftar jalur simpul untuk disertakan dalam grup properti. Grup properti tidak dapat tumpang tindih. Jika Anda tidak menentukan nilai untuk bidang ini, grup berisi semua jalur di bawah root, dan Anda tidak dapat membuat grup properti tambahan. nodeFilterRuleDefinitionsStruktur berisi informasi berikut:

tipe

OpcUaRootPathadalah satu-satunya tipe yang didukung. Ini menentukan bahwa nilai rootPath adalah jalur relatif terhadap root ruang penjelajahan OPC-UA.

RootPath

Daftar yang dibatasi koma yang menentukan jalur (relatif terhadap root) untuk disertakan dalam grup properti.

Contoh konfigurasi kemampuan

Contoh berikut mendefinisikan konfigurasi kemampuan gateway OPC-UA SiteWise Edge dari payload yang disimpan dalam file JSON.

aws iotsitewise update-gateway-capability-configuration \
--capability-namespace "iotsitewise:opcuacollector:1" \
--capability-configuration file://opc-ua-configuration.json
contoh : Konfigurasi sumber OPC-UA

opc-ua-configuration.jsonFile berikut mendefinisikan konfigurasi sumber OPC-UA dasar dan tidak aman.

{
"sources": [
  {
    "name": "Wind Farm #1",
    "endpoint": {
      "certificateTrust": {
        "type": "TrustAny"
      },
      "endpointUri": "opc.tcp://203.0.113.0:49320",
      "securityPolicy": "NONE",
      "messageSecurityMode": "NONE",
      "identityProvider": {
        "type": "Anonymous"
      },
      "nodeFilterRules": []
    },
    "measurementDataStreamPrefix": ""
  }
]
}
contoh : Konfigurasi sumber OPC-UA dengan grup properti yang ditentukan

opc-ua-configuration.jsonFile berikut mendefinisikan konfigurasi sumber OPC-UA dasar dan tidak aman dengan grup properti yang ditentukan.

{
  "sources": [
      {
          "name": "source1",
          "endpoint": {
              "certificateTrust": {
                  "type": "TrustAny"
              },
              "endpointUri": "opc.tcp://10.0.0.9:49320",
              "securityPolicy": "NONE",
              "messageSecurityMode": "NONE",
              "identityProvider": {
                  "type": "Anonymous"
              },
              "nodeFilterRules": [
                  {
                      "action": "INCLUDE",
                      "definition": {
                          "type": "OpcUaRootPath",
                          "rootPath": "/Utilities/Tank"
                      }
                  }
              ]
          },
          "measurementDataStreamPrefix": "propertyGroups",
         "propertyGroups": [

              {
                  "name": "Deadband_Abs_5",
                  "nodeFilterRuleDefinitions": [
                      {
                          "type": "OpcUaRootPath",
                          "rootPath": "/Utilities/Tank/Temperature/TT-001"
                      },
                      {
                          "type": "OpcUaRootPath",
                          "rootPath": "/Utilities/Tank/Temperature/TT-002"
                      }
                  ],
                  "deadband": {
                      "type":"ABSOLUTE",
                      "value": 5.0,
                      "timeoutMilliseconds": 120000
                  }
              },
              {
                  "name": "Polling_10s",
                  "nodeFilterRuleDefinitions": [
                      {
                          "type": "OpcUaRootPath",
                          "rootPath": "/Utilities/Tank/Pressure/PT-001"
                      }
                  ],
                  "scanMode": {
                      "type": "POLL",
                      "rate": 10000
                  }
              },
              {
                  "name": "Percent_Deadband_Timeout_90s",
                  "nodeFilterRuleDefinitions": [
                      {
                          "type": "OpcUaRootPath",
                          "rootPath": "/Utilities/Tank/Flow/FT-*"
                      }
                  ],
                  "deadband": {
                      "type":"PERCENT",
                      "value": 5.0,
                      "eguMin": -100,
                      "eguMax": 100,
                      "timeoutMilliseconds": 90000
                  }
              }
          ]
      }
  ]
}
contoh : Konfigurasi sumber OPC-UA dengan properti

Contoh JSON berikut untuk opc-ua-configuration.json mendefinisikan konfigurasi sumber OPC-UA dengan properti berikut:

  • Mempercayai sertifikat apa pun.

  • Menggunakan kebijakan BASIC256 keamanan untuk mengamankan pesan.

  • Menggunakan SIGN_AND_ENCRYPT mode untuk mengamankan koneksi.

  • Menggunakan kredensyal otentikasi yang disimpan dalam rahasia Secrets Manager.

  • Memfilter aliran data kecuali yang jalurnya dimulai dengan/WindFarm/2/WindTurbine/.

  • Menambahkan /Washington ke awal setiap jalur aliran data untuk membedakan antara “Wind Farm #2" dan “Wind Farm #2" di area lain.

{
"sources": [
  {
    "name": "Wind Farm #2",
    "endpoint": {
      "certificateTrust": {
        "type": "TrustAny"
      },
      "endpointUri": "opc.tcp://203.0.113.1:49320",
      "securityPolicy": "BASIC256",
      "messageSecurityMode": "SIGN_AND_ENCRYPT",
      "identityProvider": {
        "type": "Username",
        "usernameSecretArn": "arn:aws:secretsmanager:region:123456789012:secret:greengrass-windfarm2-auth-1ABCDE"
      },
      "nodeFilterRules": [
        {
          "action": "INCLUDE",
          "definition": {
            "type": "OpcUaRootPath",
            "rootPath": "/WindFarm/2/WindTurbine/"
          }
        }
      ]
    },
    "measurementDataStreamPrefix": "/Washington"
  }
]
}
contoh

Contoh JSON berikut untuk opc-ua-configuration.json mendefinisikan konfigurasi sumber OPC-UA dengan properti berikut:

  • Mempercayai sertifikat X.509 yang diberikan.

  • Menggunakan kebijakan BASIC256 keamanan untuk mengamankan pesan.

  • Menggunakan SIGN_AND_ENCRYPT mode untuk mengamankan koneksi.

{
"sources": [
  {
    "name": "Wind Farm #3",
    "endpoint": {
      "certificateTrust": {
        "type": "X509",
        "certificateBody": "-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w
 0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZ
 WF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIw
 EAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5
 jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBh
 MCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBb
 WF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMx
 HzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQE
 BBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVI
 k60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQ
 ITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nr
 AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auN
 KyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6Guo
 EDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw
 3rrszlaEXAMPLE=
-----END CERTIFICATE-----",
        "certificateChain": "-----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w
 0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZ
 WF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIw
 EAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5
 jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBh
 MCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBb
 WF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMx
 HzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQE
 BBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVI
 k60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQ
 ITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nr
 AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auN
 KyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6Guo
 EDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw
 3rrszlaEXAMPLE=
-----END CERTIFICATE-----"
      },
      "endpointUri": "opc.tcp://203.0.113.2:49320",
      "securityPolicy": "BASIC256",
      "messageSecurityMode": "SIGN_AND_ENCRYPT",
      "identityProvider": {
        "type": "Anonymous"
      },
      "nodeFilterRules": []
    },
    "measurementDataStreamPrefix": ""
  }
]
}