Skip to main content

EamTaskCommand

Enum EamTaskCommand 

Source
pub enum EamTaskCommand {
    New {
        name: String,
        type: String,
        target: Vec<String>,
        setting: Vec<String>,
        definition: Option<PathBuf>,
        schedule_mode: ScheduleMode,
    },
    Force {
        name: String,
    },
    Suspend {
        name: String,
    },
    Resume {
        name: String,
    },
    Cancel {
        name: String,
    },
    Modify {
        name: String,
        enable: bool,
        disable: bool,
        schedule_mode: Option<String>,
        setting: Vec<String>,
        description: Option<String>,
    },
    Delete {
        name: String,
    },
}
Expand description

eam task … — the guarded writes (07-02 Task 3; the five lifecycle/mutation verbs arrive 10-04). new carries the typed guard ladder (backup+OnDemand unguarded; mutating types and any non-OnDemand schedule need –yes; restore/install/upgrade types refuse outright — see README); force dispatches NOW, always guarded; suspend/resume/cancel/modify/delete are the two-tier guarded verbs (pure precheck → blast-radius preview fetch → confirm-with-preview → action — the refusal message IS the blast radius).

Variants§

§

New

Create a task definition (scheduleMode defaults to OnDemand — never auto-fires)

Fields

§name: String

Task definition name (any resource name — e.g. nightly-backup)

§type: String

Task type — the openapi taxonomy, three classes with different guard consequences:

  • benign (no –yes with the default OnDemand schedule): eam_backup

  • mutating (need –yes — they act on their agent targets when dispatched): eam_restart, eam_sendProject, eam_sendResource, eam_sendTags, eam_activateLicense, eam_updateLicense, eam_unactivateLicense

  • refused (exit 6 eam_task_type_refused — fleet-destructive; run from the EAM console): eam_restoreBackup, eam_installModules, eam_remoteUpgrade

Any OTHER type fails safe to the –yes rung (unknown future types stay accepted, never silently unguarded).

Example: ign eam task new nightly-backup eam_backup –target gw-a

§target: Vec<String>

Target gateway name (repeatable; the GNET agent id)

§setting: Vec<String>

Setting as K=V with scalar auto-typing — bool/int ride typed, anything else stays a string (repeatable; arrays/objects need –definition)

§definition: Option<PathBuf>

Full-JSON settings file deep-merged over the composed config.settings (the typed/array settings path)

§schedule_mode: ScheduleMode

Schedule mode (default OnDemand — never auto-fires; Immediate/Scheduled/AtTime/AtDelay require –yes)

§

Force

Force-dispatch a task NOW — destructive, refused without –yes (it dispatches to the agent targets immediately). The confirmation prompt (and every refusal) carries the blast-radius preview line.

Fields

§name: String

Task definition name to dispatch

§

Suspend

Suspend a task definition’s scheduled dispatches — TASK-scoped runtime verb (there is NO agent-level suspend on the wire; an “agent” is suspended by suspending its tasks). Refused exit 2 without –yes, the blast-radius preview in the refusal message; on a stock gateway the runtime seam honestly refuses eam_not_controller (exit 6).

Fields

§name: String

Task definition name to suspend

§

Resume

Resume a suspended task definition — the suspend inverse (TASK-scoped, like suspend). Refused exit 2 without –yes with the blast-radius preview in the message.

Fields

§name: String

Task definition name to resume

§

Cancel

Cancel a task’s PENDING execution (TASK-scoped). Refused exit 2 without –yes with the blast-radius preview in the message; nothing pending is an honest no-op (fired: false), a canCancel: false row reports the gateway’s own refusal.

Fields

§name: String

Task definition whose pending execution to cancel

§

Modify

Rewrite targeted keys of a task definition — the full-record read-modify-write (every key the gateway answered rides back; only the targeted keys change). Rename is deliberately ABSENT (the wire answers PUT-rename with 404 — see README’s create-new + delete-old composite). Refused exit 2 without –yes with the blast-radius preview in the message.

Example: ign eam task modify nightly-backup –enable

Fields

§name: String

Task definition to modify

§enable: bool

Flip the definition’s enabled key to true

§disable: bool

Flip the definition’s enabled key to false (conflicts with –enable)

§schedule_mode: Option<String>

Rewrite config.profile.scheduleMode (e.g. OnDemand, Scheduled — the scheduleDetails string itself is out of scope; the read-back shows the landed pairing)

§setting: Vec<String>

Deep-merge a settings entry over the found config.settings (K=V with scalar auto-typing; repeatable — objects merge recursively, arrays/scalars replace)

§description: Option<String>

Rewrite the definition’s description

§

Delete

Delete a task definition — signature-keyed (the gateway refuses a stale signature), behind the same –yes guard. Refused exit 2 without –yes with the blast-radius preview in the message.

Fields

§name: String

Task definition to delete

Trait Implementations§

Source§

impl Debug for EamTaskCommand

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for EamTaskCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for EamTaskCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more