Skip to Content
IoT Uygulama GeliştirmeIronFlock CLIOturum Açma ve Cihaz Yönetimi

Oturum Açma ve Cihaz Yönetimi

Bu komutlar, üzerinde çalıştıkları makineyle değil, bir IronFlock örneğiyle (bulut veya bir Appliance) konuşur. ironflock login bu makinede bir API anahtarı saklar, whoami anahtarın ait olduğu hesabı belirtir ve logout anahtarı kaldırır. Ardından ironflock device create, list ve delete projelerinizin cihazları üzerinde çalışır. agent install, os flash ve os install, --project ve --name ile cihazı sizin için oluşturabilir.

Hiçbiri root gerektirmez ve hepsi Linux, macOS ve Windows’ta çalışır. Yalnızca bu makinede işlem yaparlar: --host ve --hosts çıkış kodu 2 ile reddedilir ve ne anahtar ne de kimlik bilgisi dosyası asla başka bir makineye gider (SSH Üzerinden Uzak Makineler).

login ve whoami, API hizmeti GET /v1/ironflock/whoami isteğine yanıt veren bir IronFlock örneği gerektirir (API Uç Noktaları). IronFlock bulutu yanıt verir. Bu rotası olmayan bir IronFlock örneği 404 ile yanıt verir ve komutlar bunu söyler. Bir IronFlock Appliance, IronFlock API hizmetini çalıştırdığı andan itibaren bu rotayı sunar; bu hizmeti henüz çalıştırmayan Appliance sürümleri bu komutlarla kullanılamaz. Komutlar IronFlock örneğinin API’siyle konuşur, başka hiçbir şeyle değil, ve ironflock aracının diğer her isteği gibi ortamın proxy’sini (HTTPS_PROXY, NO_PROXY) kullanır.

IronFlock Örneği

Varsayılan buluttur. --instance ya da o yoksa IRONFLOCK_INSTANCE ortam değişkeni başka bir IronFlock örneğini belirtir: bir Appliance. Elinizde ne varsa onu verin; komut API’nin adresini ondan türetir:

VerdiğinizAPI
hiçbir şey ya da ironflock.com, studio.ironflock.com veya api.ironflock.comhttps://api.ironflock.com
Appliance’ın alan adı, factory.example.comhttps://api.factory.example.com
Studio’nun açıldığı adres, https://factory.example.com/projects/12https://api.factory.example.com
API’nin kendi ana bilgisayarı, api.factory.example.comhttps://api.factory.example.com

Şema olmadan https:// kastedilir. Düz http yalnızca bir loopback adresi için, bu makinedeki bir yığın için kabul edilir. Loopback dışındaki bir IP adresi reddedilir: bir Appliance’ın API’sine adıyla ulaşılır. Düz HTTP modundaki bir Appliance’ın api.<domain> adresi yoktur ve login ona ulaşamaz. IronFlock örneğinin sertifikası, bu makinenin güven deposuna ve --ca-cert ile verilen sertifika yetkililerine (bir PEM dosyası, birkaç tane için birden fazla kez) göre kontrol edilir; örneğin bir Appliance’ın sertifikasını imzalayan şirketinizin CA’sı. Hiçbir şey bu kontrolü kapatmaz.

Kimlik Bilgisi Dosyası

login, anahtarı kullanıcınızın yapılandırma klasöründeki ironflock klasöründe bulunan credentials.json dosyasında tutar: Linux’ta ~/.config/ironflock/, Mac’te ~/Library/Application Support/ironflock/ ve Windows’ta %LOCALAPPDATA%\ironflock\credentials\. Dosya her IronFlock örneği için bir girdi içerir ve yalnızca sizin tarafınızdan okunabilir. Başkalarının okuyabildiği veya değiştirebildiği bir dosya ya da klasör kullanılmaz: komut çıkış kodu 3 ile sona erer, nasıl onarılacağını söyler ve hiçbir şeyi değiştirmez.

Betikler ve CI için IRONFLOCK_API_KEY, her komutun saklanan anahtar yerine aldığı bir anahtarı tutar. login onu asla okumaz veya saklamaz.

DeğişkenAnlamı
IRONFLOCK_INSTANCE--instance verilmediğinde IronFlock örneği
IRONFLOCK_API_KEYSaklanan anahtar yerine kullanılacak API anahtarı
HTTPS_PROXY, NO_PROXYIronFlock örneğine yapılan istekler için proxy

ironflock login

Bir IronFlock örneğine anahtarın kime ait olduğunu sorduktan sonra, o örnek için bir API anahtarı saklar.

ironflock login [--key-file <file>] [--instance <domain or URL>] [--ca-cert <file>]...
$ ironflock login --key-file key.txt --instance factory.example.com Logged in to https://api.factory.example.com as operator (account 12). The key is stored in /home/operator/.config/ironflock/credentials.json.

Çalıştığı sistemler: Linux, macOS ve Windows. Root: gerekmez. Sorular: hiçbir şey sormaz.

BayrakAnlamı
--key-file <file>Anahtarı içeren dosya veya pipe. Varsayılan: terminal olmadığında standart girdi
--instance <instance>IronFlock örneği. Varsayılan: IRONFLOCK_INSTANCE, yoksa bulut
--ca-cert <file>Bu makinenin sertifika yetkililerine ek olarak güvenilecek bir sertifika yetkilisi; birkaç tane için birden fazla kez
  • Anahtar asla bir komut satırına yazılmaz. Bir dosyadan veya bir pipe’tan gelir ve komut onu asla terminalde sormaz. Hiçbiri olmadan çıkış kodu 2 ile sona erer ve nasıl verileceğini söyler. Anahtarın etrafındaki boşluklar atılır. Bir anahtar 0-9 ve a-f karakterlerinden oluşan 40 karakterdir; başka bir şey herhangi bir istekten önce reddedilir ve hata onu tekrarlamaz.
  • Bir şey saklanmadan önce IronFlock örneğine anahtarın kime ait olduğu sorulur. Örneğin kabul etmediği bir anahtar, yanıt veremeyen bir örnek, güvenilmeyen bir sertifika veya ulaşılamayan bir örnek çıkış kodu 1 ile sona erer ve daha önce saklanan her şey olduğu gibi kalır.
  • Zaten bir oturumu olan bir IronFlock örneğine yapılan oturum açma onun yerini alır. Diğer örneklerin oturumları kalır.
  • İstek hiçbir yönlendirmeyi izlemez; böylece anahtar başka hiçbir ana bilgisayara gitmez.
  • --json ile sonuç; action (logged_in), instance, account_id, username, scopes, restriction ve credential_file içeren tek bir nesnedir.

Anahtarı yalnızca sizin okuyabileceğiniz bir dosyaya koyun, ardından oturum açın:

(umask 077; cat > key.txt) ironflock login --key-file key.txt

cat > key.txt komutundan sonra anahtarı terminale yazın veya yapıştırın, Ctrl-D ile bitirin ve login anahtarı sakladığında key.txt dosyasını silin.

ironflock whoami

Anahtarın ait olduğu hesabı belirtir ve anahtarın neler yapabileceğini gösterir.

ironflock whoami [--instance <domain or URL>] [--ca-cert <file>]...
$ ironflock whoami --instance factory.example.com Instance: https://api.factory.example.com Account: operator (12) Scopes: devices:read, devices:write Restriction: the projects 3 Key: stored by 'ironflock login' on 2026-11-19 10:00 UTC

Anahtar, ayarlanmışsa IRONFLOCK_API_KEY, aksi halde login komutunun bu IronFlock örneği için sakladığı anahtardır. Hiçbiri yoksa komut çıkış kodu 3 ile sona erer ve çalıştırılacak login komutunu belirtir. Scopes, anahtarın kapsamlarıdır; kapsamı yoksa none. Restriction; none: everything the account may do, the projects 3, 5 veya the app 5 olur. --json ile sonuçta instance, account_id, username, scopes, restriction, key_source (environment veya credential_file) ve saklanan bir anahtar için logged_in_at bulunur.

IronFlock örneğinin artık kabul etmediği saklanan bir anahtar, örneğin Studio’da silinmiş bir anahtar, kaldırılmaz: hata, onun yerini alacak login komutunu belirtir.

ironflock logout

Bir IronFlock örneğinin saklanan anahtarını kaldırır. Diğer örneklerin oturumları kalır.

ironflock logout [--instance <domain or URL>]
$ ironflock logout --instance factory.example.com Logged out of https://api.factory.example.com: its key is removed from /home/operator/.config/ironflock/credentials.json. The key itself stays valid until it is deleted in Studio.

logout hiçbir IronFlock örneğiyle konuşmaz: anahtar, siz onu Studio’da silene kadar geçerli kalır. Saklanan bir oturumun olmaması hata değildir: komut bunu söyler ve çıkış kodu 0 ile sona erer. IRONFLOCK_API_KEY ayarlıysa bir not, komutların değişkeni kullanmaya devam ettiğini söyler.

ironflock device create

Bir projede bir cihaz oluşturur ve cihazın kimlik bilgilerini içeren .flock dosyasını yazar.

ironflock device create --project <project> --name <name> -o <file.flock> [flags]
$ ironflock device create --project 12 --name press-7 -o press-7.flock Created the device press-7 (key 345) in the project Packaging (key 12). Its .flock is in press-7.flock: it holds the device's credentials, which the platform shows no more. 'sudo ironflock agent install -c press-7.flock' connects a machine as this device.

Çalıştığı sistemler: Linux, macOS ve Windows. Root: gerekmez. Gerektirdiği: devices:write kapsamına sahip bir anahtar; adıyla verilen bir proje devices:read ile aranır.

BayrakAnlamı
--project <project>Zorunlu. Projenin anahtarı veya adı
--name <name>Zorunlu. Cihazın adı: 1 ila 100 harf, rakam, nokta, alt çizgi ve kısa çizgi. Projede henüz bu adda bir cihaz olmamalıdır
-o, --output <file>Zorunlu. .flock için *.flock adlı dosya ya da standart çıktı için -
--description <text>En fazla 2000 karakter
--wifi-ssid <name>Cihazın Wi-Fi ağı. --wifi-password-file ile birlikte verilir
--wifi-password-file <file>Ağın parolasını içeren dosya veya pipe. --wifi-ssid ile birlikte verilir
--force-o dosyası varsa onu değiştirir
--instance, --ca-certwhoami için olduğu gibi
  • Adıyla verilen bir proje, anahtarın çalışabildiği projeler arasında aranır ve tam olarak bir projenin adı olmalıdır. Hiçbir projenin adı olmayan bir ad çıkış kodu 1’dir. Birkaç projenin adı olan bir ad çıkış kodu 2’dir ve mesaj bu projelerin anahtarlarını belirtir.
  • .flock dosyası ilk baytından itibaren özeldir: mod 0600 ya da Windows’ta yalnızca size izin veren bir erişim listesi. Var olan bir dosya --force olmadan değiştirilmez ve klasör ile ad, cihaz oluşturulmadan önce kontrol edilir, çünkü API kimlik bilgilerini yalnızca cihaz oluşturulduğunda döndürür. FAT biçimli bir USB bellek gibi dosya modları olmayan bir dosya sisteminde dosya özel değildir: onu makinenin bir diskine yazın ve oradan kopyalayın.
  • -o - dosyayı standart çıktıya yazar; standart çıktı bir terminal olmamalıdır, örneğin dosyayı başka bir makineye pipe ile aktarmak için. Sonuç satırı bu durumda standart hataya gider.
  • Dosyadan hiçbir şey yazdırılmaz: sonuç cihazı anahtarı ve adıyla, projeyi de belirtir.
  • Cihaz oluşturulduktan sonra bir şey başarısız olursa hata bunu söyler ve cihazı silen komutu belirtir.

Dosyayla bir makineyi Cihaz Ajanı Komutları sayfasında açıklandığı gibi bağlayın ya da onu os flash ile bir sürücüye yazın.

ironflock device list

Hesabınızın hakları olduğu cihazları, anahtarın işlem yapabildiği projeler içinde listeler.

ironflock device list [--project <project>] [--instance <instance>] [--ca-cert <file>]...
$ ironflock device list --project Packaging KEY NAME PROJECT STATUS ARCHITECTURE AGENT 17 press-7 12 CONNECTED amd64 1.4.2 18 press-8 12 CONFIGURING amd64 -

Gerektirdiği: devices:read kapsamına sahip bir anahtar. --project tek bir projenin cihazlarını tutar. Hiç cihaz olmaması hata değildir: komut No devices. der. --json ile sonuçta instance ve devices bulunur; her cihazda device_key, name, project_key, description, status, architecture ve agent_version vardır. Yanıttan yalnızca bu alanlar okunur: bir cihazın kimlik bilgileri asla bunlar arasında değildir.

ironflock device delete

Bir cihazı bir projeden siler. Silinen bir cihaz geri getirilemez.

ironflock device delete --project <project> <device_key> [--yes] [--instance <instance>] [--ca-cert <file>]...
$ ironflock device delete --project Packaging 17 This deletes the device 17 from the project Packaging (key 12) of https://api.ironflock.com. A deleted device cannot be brought back. Delete the device 17? [y/N] Deleted the device press-7 (key 17) from the project 12.

Gerektirdiği: devices:write kapsamına sahip bir anahtar. Cihazın anahtarı tek bağımsız değişkendir. Komut neyin silineceğini söyler ve önceden Hayır seçili olarak sorar; --yes evet yanıtını verir. Terminal olmadan ve --json ile hiçbir şey sormaz ve --yes verilmedikçe çıkış kodu 4 ile sona erer: bu durumda hiçbir şey silinmez. Projede olmayan ya da anahtarın göremediği bir cihaz 404’tür.

--project ve --name ile Yeni Bir Cihaz Kurma

ironflock agent install, ironflock os flash ve ironflock os install, -c <device.flock> yerine --project <project> --name <name> alır. Komut cihazı oluşturur ve platformun gönderdiği .flock ile, tam olarak -c dosyasıyla devam ettiği gibi devam eder. .flock bellekte tutulur, ilgilenmeniz gereken hiçbir dosyada değil.

sudo ironflock agent install --project Packaging --name press-9 --yes ironflock os flash --project 12 --name cell-4 -d /dev/sdb ironflock --host admin@machine os install --project 12 --name cell-4 --disk /dev/sda --yes --wait-online
BayrakAnlamı
--project <project>Cihazın oluşturulacağı proje: device create için olduğu gibi anahtarı veya adı
--name <name>Yeni cihazın adı, device create için olduğu gibi
--instance <instance>IronFlock örneği, whoami için olduğu gibi
--ca-cert <file>agent install: IronFlock örneğinin sertifikasının bir sertifika yetkilisi. os flash ve os install komutlarının cihaz için kendi --ca-cert bayrağı vardır; --project ile bu, IronFlock örneği için de güvenilir kabul edilir
--wait-online[=<duration>]Yalnızca --host üzerinden os install: oradaki komuttan sonra, platformun cihazı çevrimiçi görmesi için süre kadar (1 dakika ile 2 saat arası; tek başına 15 dakika) bekler. Değer, --wait-online=20m örneğindeki gibi = işaretinden sonra gelir
  • --project ve --name birlikte verilir ve -c ile birlikte kullanılamaz. agent install ve os flash ikisinden birini gerektirir; os install ikisi de olmadan, önceden olduğu gibi kurulu ajanın .flock dosyasını alır. --project ile --dry-run reddedilir, çünkü bir deneme çalıştırması hiçbir şey oluşturmaz.
  • Anahtar, whoami komutununkiyle aynıdır: IRONFLOCK_API_KEY, yoksa saklanan oturum. sudo ile çalıştırılan bir komut root olarak çalışır ve root’un oturumunu arar: anahtarı sudo --preserve-env=IRONFLOCK_API_KEY ile aktarın ya da komutu kendi makinenizden --host ile çalıştırın. --host ile platforma sizin makinenizden sorulur ve makine yalnızca .flock dosyasını alır: anahtar, kimlik bilgisi dosyası ve IRONFLOCK_API_KEY ona asla ulaşmaz.
  • Platform bir cihazın .flock dosyasını yalnızca onu oluşturan yanıtta verir. Bu nedenle projede zaten bulunan bir ad reddedilir (çıkış kodu 1): o cihazı .flock dosyası ve -c ile kurun ya da önce device delete ile silin.
  • Cihaz oluşturulduktan sonra bir adım başarısız olursa hata bunu söyler ve cihazı kaldıran device delete komutunu belirtir. Onu, ardından aynı komutu yeniden çalıştırın.

Hatalar

Bir hata, çıkış kodu 1 ve bir cümleyle sona erer. IronFlock örneğinin cümlesi durum kodundan sonra gelir.

YanıtCümlenin söylediği
Ulaşılamadı, sertifikaya güvenilmiyorIronFlock örneğine ulaşılamıyor; --ca-cert için bir ipucuyla
400IronFlock örneği isteği reddetti ve nedeni
401IronFlock örneği anahtarı kabul etmiyor ve anahtarın nereden geldiği. Saklanan bir anahtar için, onun yerini alacak login
403Anahtar bunu yapamaz: kapsamları ya da sınırlı olduğu projeler veya uygulama buna izin vermiyor. whoami bunları gösterir
404delete için: cihaz projede değil ya da anahtar onu göremiyor. create için: proje bu anahtar için yok
409Platformun tuttuğu bir şeyle çakışma, örneğin projede zaten bulunan bir cihaz adı
500, 503, 504Platform kullanılamıyor. create ve delete için ayrıca değişikliğin yapılmış olabileceği ve bunu gösteren device list

İstek yazıldıktan sonraki herhangi bir hatadan sonra ve create veya delete beklerken basılan Ctrl-C’den sonra mesaj, değişikliğin yapılmış olabileceğini söyler. Tekrarlamadan önce ironflock device list çalıştırın: aynı adla ikinci bir create bir çakışmadır ve API ilk cihazın kimlik bilgilerini yeniden döndürmez (Studio yapılandırma dosyasını indirebilir).

Çıkış Kodları

Bu komutlar her komutun çıkış kodlarını kullanır.

KodBuradaki anlamı
0Tamamlandı
1IronFlock örneği veya platform reddetti ya da başarısız oldu, bir proje adı hiçbir projenin adı değil ya da bir dosya yazılamadı
2Komut satırı hatalı: eksik veya yanlış bir bayrak, birkaç projenin adı olan bir proje adı, --force olmadan var olan bir dosya, --host veya --hosts. Platforma sorulmadı
3Oturum yok: IRONFLOCK_API_KEY ayarlı değil ve saklanan bir oturum yok; ya da kimlik bilgisi dosyası kullanılamıyor. Platforma sorulmadı
4device delete sorusu hayır ile yanıtlandı ya da sorulamadı ve --yes verilmedi. Hiçbir şey silinmedi
130Platforma sorulurken kesildi. Değişiklik yapılmış olabilir
Last updated on