From patchwork Thu Feb 13 16:11:54 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pedro Aguilar X-Patchwork-Id: 1237581 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2a00:1450:4864:20::43b; helo=mail-wr1-x43b.google.com; envelope-from=swupdate+bncbaabb2pksxzakgqepxtrmyi@googlegroups.com; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=vimar.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20161025 header.b=CoZnP7Jn; dkim-atps=neutral Received: from mail-wr1-x43b.google.com (mail-wr1-x43b.google.com [IPv6:2a00:1450:4864:20::43b]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48JM3j2SSzz9sTD for ; Fri, 14 Feb 2020 03:12:33 +1100 (AEDT) Received: by mail-wr1-x43b.google.com with SMTP id t3sf2509575wrm.23 for ; Thu, 13 Feb 2020 08:12:33 -0800 (PST) ARC-Seal: i=3; a=rsa-sha256; t=1581610346; cv=pass; d=google.com; s=arc-20160816; b=HObXtyi3oAqWF/2vwJWcjh5uSSBZAGvOzJDO6eIRvNih5k+NBI6haYlur06vueN8mA iuHKdBgaZ9FwxmueT9t4SJ2fD8np9qi7xCbtkrqkIYHJpCRl8I1gO+haEsJMfB6RCPAf ZK0RoLc+ZVsRoXm5K3bHIkVNP/V0PaolyMt5O+PtHbUBjKmpzQDxmElUYEBRRO73JQ4Z dViJWQSjxeaKDmqTYn1GivYqu22URDF00h8LqFaF+BBJEjHOkDfQ3oKBbSiHPr7VWZxX jQHL4xzZZOLZnILd/AvsF1pp5JO1BgsRPSGR232foCbSfIxD6fk54vP8Cph8tpkPz334 awew== ARC-Message-Signature: i=3; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:sender:dkim-signature; bh=9DQUYZPN9aBQ4dsiV4R5TmnJZkm4vWajuvSMHcHWfbk=; b=oDFS6vSgOHABxhx90OwTBFdwuC7VHl9h9CBOAAluEJ2JwVSaFq0JruEqezS3gan8xQ +cJjKV3EsTW8tytHevEr/glGv51bUW3JFG3bST+n7qbMw4Aay9JkdVoUuXCKRLmVdRnZ jSMzhjSe9eBR382Dy50CfuM3P9bUZe3UwMOMZ9WDck/EmTOo5Uose3sHXKVUfk7GESjO cWPROIjEPJxOKFCAhlZc+eiMVT2IYapDQwH/iqGZ4Gvx0o8Ieh5tfs1aY4cn407tLU8d bhenOUFNvuWUR6cfyk/qxicKhGsXH1eUWYrFEyImzsAkrmg7bll4LlwFrHwf3NSfRG9S t2IQ== ARC-Authentication-Results: i=3; gmr-mx.google.com; dkim=pass header.i=@Vimargroup.onmicrosoft.com header.s=selector2-Vimargroup-onmicrosoft-com header.b=SywbdnYK; arc=pass (i=1 spf=pass spfdomain=vimar.com dkim=pass dkdomain=vimar.com dmarc=pass fromdomain=vimar.com); spf=pass (google.com: domain of pedro.aguilar@vimar.com designates 40.107.5.89 as permitted sender) smtp.mailfrom=Pedro.Aguilar@vimar.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=9DQUYZPN9aBQ4dsiV4R5TmnJZkm4vWajuvSMHcHWfbk=; b=CoZnP7JnKzgIeuYMtXg4WTOk/8uaT4Qdmz3PkG2dJuouZ6/uMlm0EJuVZpb9P4JWcE xPOiX5aKFdm3z1Hn0qmU725YbAx1plWoOI09ot27LNz+ZRGqslEgWA1o950/EjdCnheK i6Saw1Z3Z3YDN+tyI/d37ayb5rc8NjA5aExSFo5LClT8t+YBI/+nRWnc/J/ee0a5pFn7 n8QukIAxkUKo/+Ac8F+xskjQGV4ogPLgPL1LdHT+LvDjfWHxc9CRPY4wVcq7K6jl9G9G mnclrsa7u9JbwI3B+pzbEE+M1FfljAkCh81aB8mMdjbfl5B1AHSnV0cbbG48o/vSIsza Fliw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=sender:x-gm-message-state:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :x-spam-checked-in-group:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=9DQUYZPN9aBQ4dsiV4R5TmnJZkm4vWajuvSMHcHWfbk=; b=bzX6z2r/1cRaLdb7mq+2KuMD3lf4opWcs5MWhoG4/6AhZdNIyLC9Nb5kQqcEMQChuQ 8Ay0anz6VyrN9dEzO7h8zemx6oE4vO5RBuMis90ziIItm5g3/aIuzIMhtU4EiF0iVTI8 jkAOVcIjHEr1bcXOrgXbsN2N9y78rR72ZBE0MpAxQoP2xyKzDlMMdceZbVoEBX8Nr1hF fWw7r4yMq/3AearDhH/99hTmAAXIbtHt9R7vIKj6GI38xf78P0Lm2gm9MEMG1wqt5KDG gw/sibSFsDoBo6KFm7aAEx1SwWRAIhydrzplXrgBhAZZnvd4qB5w59ra736DSmlrl43c W6hQ== Sender: swupdate@googlegroups.com X-Gm-Message-State: APjAAAUtRAMrEgtxUb/hffnX7snBjzSTmLszA/vbBBeFWaOPHd0p5/Zi c+6QW5Om2tOmt8q7RDeSk4Y= X-Google-Smtp-Source: APXvYqykkOsVvrpRPEdO2OwUD9tIUjjrm9zJP5dqJUfwaccMby/Sb4ynTDAQrlxRtcy+yD8VRatpdA== X-Received: by 2002:adf:c453:: with SMTP id a19mr22712957wrg.341.1581610346406; Thu, 13 Feb 2020 08:12:26 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:adf:fac2:: with SMTP id a2ls13720167wrs.4.gmail; Thu, 13 Feb 2020 08:12:25 -0800 (PST) X-Received: by 2002:adf:b64b:: with SMTP id i11mr23843491wre.58.1581610345522; Thu, 13 Feb 2020 08:12:25 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1581610345; cv=pass; d=google.com; s=arc-20160816; b=npnYnILb9PBwz9n6BLntxH/lTN8R6Ad5b9IZGv53FaQZGDFsf9hCHFhvnFNB6pcntW yrO2rPbgFx0MZ6TeIRscVUAUQR/6nRanDpFDNtblTPY1AxTIyytx1+SUI4bU1hEaPi96 lkMZAaoCNUavzIKJTf6TU4Y7McDPJ6yBF+BrVWADHuq04Lqfq/hIaa9+3/LnIllSuQdq PefFnVog9qpXrAH6ZlPLkRm3wBlQ4F3tMMohVZbFffL4tXPHr4oxGtEand75eB/VYqel x7tSj7IaIFe2jAaeQGrB35MVSOFW4NW+m0GuvXkgPl7dF9Gcxbq2KEUQx/JMQMa/7n4d XadQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=GXYU7yA5lpbsIZwauuTdjjaOclWZt8ut9oXHILAXoU4=; b=vmxgqn0hmYh/FZtmJuV7SY1K4KiPqo96GVp9D8AMId5v4pXH6Tfgw/r0S3bxg693Mg CiyWxxqZjFdEbuA0oCHpOFiZRgt5Sx3rvDicB0AKV7SPGwJhksTTqM84W5XM8Cox4SNR 6Vz/YV7HH4t9+MDTDDaEMLaiD0kCnlDxBkklOoNWUXRKRgnKb1dV9pRVqUtuyAwWhvXR LsWjf2Aq2LA1MziQQlARXYC8FGHipB5D1SV8GLv2T9z/98Lpm7gOtRY6wawudReoa8kC u+tieRPmI0RxIKujisXMPOQv/psRvzfR/uNo265L2sePGKifdTp/nuE2jjZWBbB0mkri z+8Q== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@Vimargroup.onmicrosoft.com header.s=selector2-Vimargroup-onmicrosoft-com header.b=SywbdnYK; arc=pass (i=1 spf=pass spfdomain=vimar.com dkim=pass dkdomain=vimar.com dmarc=pass fromdomain=vimar.com); spf=pass (google.com: domain of pedro.aguilar@vimar.com designates 40.107.5.89 as permitted sender) smtp.mailfrom=Pedro.Aguilar@vimar.com Received: from EUR03-VE1-obe.outbound.protection.outlook.com (mail-eopbgr50089.outbound.protection.outlook.com. [40.107.5.89]) by gmr-mx.google.com with ESMTPS id i15si169683wro.2.2020.02.13.08.12.25 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 13 Feb 2020 08:12:25 -0800 (PST) Received-SPF: pass (google.com: domain of pedro.aguilar@vimar.com designates 40.107.5.89 as permitted sender) client-ip=40.107.5.89; ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=AuRyzP4AZesi106tjh0DJ4dSAmcCYoTb0rkzoSQSJm3YdfKMJaTGEePVlbA48Rraeu/uknciRJk+D8519fADAT1lXcufA1fj9lGycrLYL/63vNoDXH6hQjANem30FYej8ccBgUm6jY/EaQIEa/HJxLSYl/o4Q9iRjpYYZCsnIOQ3rT+CQajcIpq23Yf9pC3xaJzH1Q9kmWr8dnzAyHduo1gsJfEfyN/Cpds3BHscgK2+9kUGWrvpKdlDFVx/hy2oCn36xmHDV6k1ydC9znfiAByIG+0yE+HeQ/x3UyaXeKMg5G7ojxChbzHw4JgwpUTQNXNJzA1/0ECNLehOvFkjqA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=GXYU7yA5lpbsIZwauuTdjjaOclWZt8ut9oXHILAXoU4=; b=dliAMOraT/kkjqXEzWM/V0pgy07TrsoQP8MuMxNFe1bCBW6XVbZ3xTC1Xyuecar0BLi/1lVlKDzfEd+oGIelHT3zJc0+Di+5uhKKMbuJY3ScOVHNd7EAobbtD5yPokOZXq76Xxr+CndgasfZZOZwHrnHBhPQoCV7ihvkjZCwnPVtb0Aa+muD9pGxjrNnV6K3y1NOFFAqLof+KxHwbFYvXyyAxTDPt3sDcc0MAyuUExrRjn27QDdPqlwScNtewZDl3TJr/TSL1tx3uuzg2eu2jqXLfV2D7qDmsr4reCsWg44gR8zHABPVE8y/hiE0p8iLZ27qM5pUbA/hdp3mh4NQ8A== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=vimar.com; dmarc=pass action=none header.from=vimar.com; dkim=pass header.d=vimar.com; arc=none Received: from AM0PR08MB3138.eurprd08.prod.outlook.com (52.134.126.14) by AM0PR08MB4388.eurprd08.prod.outlook.com (20.179.33.206) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2707.25; Thu, 13 Feb 2020 16:12:22 +0000 Received: from AM0PR08MB3138.eurprd08.prod.outlook.com ([fe80::d8de:211c:f5b2:3ea3]) by AM0PR08MB3138.eurprd08.prod.outlook.com ([fe80::d8de:211c:f5b2:3ea3%7]) with mapi id 15.20.2707.031; Thu, 13 Feb 2020 16:12:22 +0000 From: Pedro Aguilar To: swupdate@googlegroups.com Cc: Pedro Aguilar , Luca Pesce Subject: [swupdate] [PATCH] doc: Add command line arguments for suricatta and downloader. Date: Thu, 13 Feb 2020 17:11:54 +0100 Message-Id: <20200213161154.7492-1-pedro.aguilar@vimar.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <1581581030-29912-1-git-send-email-luca.pesce@vimar.com> References: <1581581030-29912-1-git-send-email-luca.pesce@vimar.com> X-ClientProxiedBy: AM0PR02CA0061.eurprd02.prod.outlook.com (2603:10a6:208:d2::38) To AM0PR08MB3138.eurprd08.prod.outlook.com (2603:10a6:208:66::14) MIME-Version: 1.0 Received: from localhost.localdomain (93.62.232.162) by AM0PR02CA0061.eurprd02.prod.outlook.com (2603:10a6:208:d2::38) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2707.27 via Frontend Transport; Thu, 13 Feb 2020 16:12:22 +0000 X-Mailer: git-send-email 2.17.1 X-Originating-IP: [93.62.232.162] X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 975a03e8-9b92-4491-c5fb-08d7b09f8213 X-MS-TrafficTypeDiagnostic: AM0PR08MB4388:|AM0PR08MB4388: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:3826; X-Forefront-PRVS: 031257FE13 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4636009)(366004)(396003)(39850400004)(376002)(346002)(136003)(199004)(189003)(5660300002)(86362001)(6506007)(52116002)(478600001)(66476007)(26005)(54906003)(6486002)(6916009)(66556008)(66946007)(316002)(36756003)(81166006)(956004)(8936002)(44832011)(2616005)(8676002)(16526019)(186003)(1076003)(69590400006)(2906002)(81156014)(4326008)(107886003)(6666004)(6512007); DIR:OUT; SFP:1101; SCL:1; SRVR:AM0PR08MB4388; H:AM0PR08MB3138.eurprd08.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: vimar.com does not designate permitted sender hosts) X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: ZzLJIk/sVHxx9RvKMv5mZekR/RGnUq9PPN2c8tMnQRXlruiX4zIOCn3ZCh1IxVBMXrMo/zqSQQ09J58SThDLzQkqghEjbL+32ve50qB6TSVJTL/wMPE74WnMSpXqdiqaxvsVHMuXLZRWKeN8SDRuczqym7LlJrzBRMzaf6LRCuRr5MlokfHasjbXKPJk/If1BBUCnBQuzXUKWcDj5p4VjnAeW/WKBiwXsZoScKUtsQi32lul8IM2bwXg2rumJIgfcpxMvHUBabY5ctNZx+CD6Ob5gT43nfqPa70Q9AYAbmwg8r6stMiCLwEZ4QK0HNHKD/zVfymsfmYO4Lhy5qoIQwRHvFS05wAfS1GcVHnAID4pydzMsEW56MqBci1srYXegO1pSPMnbSPAlmJbkB+xNgkMrChEdKPDVa20cukWDelMmp367UFY0mpPCU2PnbFGNDb1j3n9R1in76oTw8T9GNuiLPeD4QoXZ8IE+ipqhFIVj5Y2M4Sj7HdT78MIoNiwscA0bT0hV+eTAk6NeXujuhLc8oHC6t4wz+KjhfssxoM= X-MS-Exchange-AntiSpam-MessageData: 18sTULDVAyC6brmoPiq3l72QubER6l3M2MFjbK9BAfqp5WJ5/0TlLy2xr9zTFeyFhD535MmGtiPQ1HNhFVQGMY8SPVQ1aN0qydzErgC3MZXkwKH6yeAJNLouz5QDs968Ay8unWpxElwEB3a+3+AMGQ== X-OriginatorOrg: vimar.com X-MS-Exchange-CrossTenant-Network-Message-Id: 975a03e8-9b92-4491-c5fb-08d7b09f8213 X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Feb 2020 16:12:22.7705 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a1f008bc-d59b-4c66-8f87-60fd9af15c7f X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: LLsTyj2rEckbraCN6QBvzPGmP6/AKpGqL2zH1MmSAqomGI7uKU+NwimDgG69qEEZ1Lo9FWq2BwBa6zdZy+TH0A== X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR08MB4388 X-Original-Sender: pedro.aguilar@vimar.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@Vimargroup.onmicrosoft.com header.s=selector2-Vimargroup-onmicrosoft-com header.b=SywbdnYK; arc=pass (i=1 spf=pass spfdomain=vimar.com dkim=pass dkdomain=vimar.com dmarc=pass fromdomain=vimar.com); spf=pass (google.com: domain of pedro.aguilar@vimar.com designates 40.107.5.89 as permitted sender) smtp.mailfrom=Pedro.Aguilar@vimar.com Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , Signed-off-by: Pedro Aguilar Signed-off-by: Luca Pesce --- doc/source/swupdate.rst | 60 +++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 8 deletions(-) diff --git a/doc/source/swupdate.rst b/doc/source/swupdate.rst index 9157d1d..2b394ab 100644 --- a/doc/source/swupdate.rst +++ b/doc/source/swupdate.rst @@ -472,9 +472,16 @@ Command line parameters | -w | string | start internal webserver and pass to it | | | | a command line string. | +-------------+----------+--------------------------------------------+ +| -d | string | Active only if CONFIG_DOWNLOAD is set | +| | | start internal downloader client and pass | +| | | to it a command line string. | +| | | See below the internal command line | +| | | arguments for the downloader. | ++-------------+----------+--------------------------------------------+ | -u | string | start internal suricatta client daemon and | | | | pass to it a command line string. | -| | | see suricatta's documentation for details. | +| | | See below the internal command line | +| | | arguments for suricatta. | +-------------+----------+--------------------------------------------+ | -H | string | set board name and Hardware revision | | | | | @@ -488,14 +495,14 @@ Command line parameters +-------------+----------+--------------------------------------------+ | -p | string | Execute post-update command. | +-------------+----------+--------------------------------------------+ + +Parameters used for the downloader: -d, --download [OPTIONS] +For example: -d "-u example.com" +Mandatory arguments are marked with '*': +-------------+----------+--------------------------------------------+ -| -d | string | Active only if CONFIG_DOWNLOAD is set | -| | | start internal downloader client and pass | -| | | to it a command line string. | -| | | See below the internal command line | -| | | arguments for the downloader | -+-------------+----------+--------------------------------------------+ -| -u | string | This is the URL where new software is | +| Parameter | Type | Description | ++=============+==========+============================================+ +| -u | string | * This is the URL where new software is | | | | pulled. URL is a link to a valid .swu image| +-------------+----------+--------------------------------------------+ | -r | integer | Number of retries before a download is | @@ -509,6 +516,43 @@ Command line parameters | -a | string | Send user and password for Basic Auth | +-------------+----------+--------------------------------------------+ +Parameters used for suricatta: -u, --suricatta [OPTIONS] +For example: -u "-t default -u localhost:8080 -i 1B7" +Mandatory arguments are marked with '*': ++-------------------+----------+--------------------------------------------+ +| Parameter | Type | Description | ++===================+==========+============================================+ +| -t | string | * Set hawkBit tenant ID for this device. | ++-------------------+----------+--------------------------------------------+ +| -u | string | * Host and port of the hawkBit instance, | +| | | e.g., localhost:8080 | ++-------------------+----------+--------------------------------------------+ +| -i | integer | * The device ID to communicate to hawkBit. | ++-------------------+----------+--------------------------------------------+ +| -c | integer | Confirm update status to server: 1=AGAIN, | +| | | 2=SUCCESS, 3=FAILED | ++-------------------+----------+--------------------------------------------+ +| -x | - | Do not abort on flawed server certificates.| ++-------------------+----------+--------------------------------------------+ +| -p | integer | Delay in seconds between two hawkBit poll | +| | | operations (default: 45s). | ++-------------------+----------+--------------------------------------------+ +| -r | integer | Resume and retry interrupted downloads | +| | | (default: 5 tries). | ++-------------------+----------+--------------------------------------------+ +| -w | integer | Time to wait prior to retry and resume a | +| | | download (default: 5s). | ++-------------------+----------+--------------------------------------------+ +| -y | string | Use proxy. Either give proxy URL, | +| | | else {http,all}_proxy env is tried. | ++-------------------+----------+--------------------------------------------+ +| -k | string | Set target token. | ++-------------------+----------+--------------------------------------------+ +| -g | string | Set gateway token. | ++-------------------+----------+--------------------------------------------+ +| -f | string | Set the network interface to connect to | +| | | Hawkbit. | ++-------------------+----------+--------------------------------------------+ systemd Integration -------------------