bc-clijob property

Set/clear a job property. Properties are defined as environment variables when a command job is executed, and parameters when calling a webhook.

Usage

job property set name property value
job property delete name property

where
set the specified property.
delete the specified property.
name of job whose property to set/delete.
property to set/delete.
value to set property to. If not specified an empty property will be defined. See variables for available variables that can be included in the message.
Property name prefixes

Property names may include one or more of the following prefixes.

h header property. When defined within a webhook job, the property will be passed as a header property,
instead of as a parameter. e.g. h:x-api-key
p private property. The values of these properties are only visible to users that have write access to
the properties job. e.g p:password or hp:x-api-key

write on name

Examples

Add a property

BeyondCron % job property set /examples/server/reboot PATH /sbin:/bin
BeyondCron % job list full reboot

----------- -------------------------------- Name /examples/server/reboot Description Weekly reboot ... Properties PATH: /sbin:/bin

Change a property

BeyondCron % job property set /examples/server/reboot PATH /sbin
BeyondCron % job list full reboot

----------- -------------------------------- Name /examples/server/reboot Description Weekly reboot ... Properties PATH: /sbin

Add an empty property

BeyondCron % job property set /examples/server/reboot DEBUG
BeyondCron % job list full reboot

----------- -------------------------------- Name /examples/server/reboot Description Weekly reboot ... Properties PATH: /sbin DEBUG:

Delete a property

BeyondCron % job property delete /examples/server/reboot DEBUG
BeyondCron % job list full reboot

----------- ----------------------- Name /examples/server/reboot Description Weekly reboot ... Properties PATH: /sbin

Add a private header property

BeyondCron % job property set /examples/webhooks/private-property hp:x-api-key g577uiO1As4qBqE…
BeyondCron % job list full private-property

----------- ------------------------------------------------- Name /examples/webhooks/private-property Description Call an AWS webhook with a private header API key ... Properties hp:x-api-key: g577uiO1As4qBqE...

Property listing as seen by a different user without write access to the job:

BeyondCron % job list full private-property

----------- ------------------------------------------------- Name /examples/webhooks/private-property Description Call an AWS webhook with a private header API key ... Properties hp:x-api-key: ****************

See also