--active |
flag |
|
attach-measure-consumer only: attach the consumer DEPLOYED (Active = true), so the integration engine starts sending immediately. Default false matches the GUI, which attaches undeployed behind an explicit Deploy button |
--add-chart-component |
flag |
|
Add a ChartComponent + ChartComponentDetail to a chart, validated against the parent node's CanAdd() offer - an unoffered type is refused with the legal list; --force writes it anyway (requires --chart-id, --chart-component-type-id, --parent-chart-component-id) |
--add-chart-item |
flag |
|
Add a ChartItem + ChartItemDetail to a chart component, validated against the component's CanAddItems() offer; --force overrides (requires --chart-component-id, --chart-item-type-id; optionally --parent-chart-item-id, --measure-id, --measure-limit-id, --event-attribute-id, --display-order) |
--add-chart-measure |
flag |
|
Add a measure, metric or event scheme to a chart node exactly like GUI drag-drop — the chart type builds the appropriate sub-tree (stack/axis/measure item, or an event-scheme component with its attribute items) with defaults (requires --chart-component-id or --chart-item-id, plus one of --measure-id, --metric-id or --event-scheme-id) |
--add-dashboard-panel |
flag |
|
Add a DashboardPanel to a dashboard (requires --dashboard-id, --chart-id, --panel-left, --panel-top, --panel-width, --panel-height) |
--add-enumeration-group-ordinal |
flag |
|
Add an ordinal row to an enumeration group (requires --enumeration-group-id, --ordinal; optionally --ordinal-values) |
--add-enumeration-ordinal |
flag |
|
Add an ordinal to an enumeration (requires --enumeration-id, --ordinal, --value; optionally --color) |
--add-event-attribute |
flag |
|
Add an EventAttribute to an EventScheme (requires --event-scheme-id, --name, --attribute-type manual|calculation|segment) |
--add-event-attribute-segment |
flag |
|
Append a segment to an existing EventAttribute (requires --event-attribute-id, --segment-name, --segment-type) |
--add-event-attribute-value |
flag |
|
Add an attribute value option to an event attribute (requires --event-attribute-id, --name; optional --color) |
--add-event-trigger |
flag |
|
Add an EventTrigger to an EventScheme (requires --event-scheme-id; optional --event-trigger-type Start|End, --connection-id, --item-name, --item-property) |
--add-group-member |
flag |
|
Add a user to a group (requires --group-id, --username-id) |
--add-loop-dashboard |
flag |
|
Add a dashboard to a loop (requires --dashboard-loop-id, --dashboard-id; optional --display-period, --display-order) |
--add-measure-calculation |
flag |
|
Append a MeasureCalculation history row to an existing calculation measure (requires --measure-id, --expression, --calculation-datetime) |
--add-message-section |
flag |
|
Add a section to a message definition (requires --message-definition-id, --name; optional --is-subject) |
--add-message-segment |
flag |
|
Add a segment to a message section (requires --message-section-id, --message-segment-type; optional --segment-text, --measure-id, --dashboard-id, --chart-id) |
--add-message-trigger |
flag |
|
Add a trigger to a message definition (requires --message-definition-id, --message-trigger-type) |
--add-model-attribute-option |
flag |
|
Add a dropdown option to a model attribute (requires --model-attribute-id, --value; optional --display-order) |
--add-shift-scheme-interval |
flag |
|
Add an interval to a shift scheme (requires --shift-scheme-id, --shift-id, --interval-start, --interval-count) |
--aggregation-interval-type |
string |
|
Override the source interval type used by the aggregation row (default: next interval up from source measure) |
--aggregation-scaling |
double? |
|
Scaling factor applied to the aggregation (default: 1.0) |
--aggregation-type |
string |
|
Aggregation type for aggregation measures: Sum, Average, Minimum, Maximum, Counter, First, Last, Range, Delta (default: Sum) |
--aggregation-types |
string |
|
Comma-separated aggregation types: average,sum,min,max,count,first,last |
--allow-fuzzy-matching |
flag |
|
Allow fuzzy name matching |
--attach-event-trigger-event-scheme |
flag |
|
Attach another EventScheme as the source of an event trigger (requires --event-trigger-id, --event-scheme-id, --trigger-type-id; optionally --event-attribute-id, --attribute-value) |
--attach-event-trigger-refresh-trigger |
flag |
|
Attach a refresh trigger to an event trigger, so it re-evaluates when the source data changes (requires --event-trigger-id, --connection-id, --time-scheme-id; optionally --interval-type). One per event trigger. The connection's plugin must support checking for modified data. |
--attach-event-trigger-time-scheme |
flag |
|
Attach a calendar (TimeScheme) source to an event trigger, so the event starts/ends on interval boundaries (requires --event-trigger-id, --time-scheme-id, --interval-type; optionally --interval-count, --interval-start-interval-type) |
--attach-measure-connection |
flag |
|
Attach a Connection to a Measure with plugin properties (requires --measure-id, --connection-id, --item-name; optional --item-uom/--item-description/--item-reference/--item-property/--target) |
--attach-measure-consumer |
flag |
|
Attach a Consumer to a Measure with plugin properties (requires --measure-id, --consumer-id; optional --consumer-property). Uses the default Integration Engine, as the GUI does. On a measure that is not a tag the consumer goes under one of the measure's calendars or event schemes: --time-scheme-id or --event-scheme-id, required only when the measure has more than one |
--attach-measure-event-scheme |
flag |
|
Attach an EventScheme to a Measure (requires --measure-id, --event-scheme-id; optional --copy-attributes) |
--attach-measure-limit |
flag |
|
Attach a Limit to a Measure (requires --measure-id, --limit-id and exactly one of --time-scheme-id/--event-scheme-id - defaults to the measure's single active time scheme; optional --comparator-type, --high, --low) |
--attach-measure-time-scheme |
flag |
|
Attach a TimeScheme to a Measure (requires --measure-id, --time-scheme-id) |
--attach-measure-time-scheme-refresh-trigger |
flag |
|
Attach a refresh trigger to one of a measure's calendars, so it re-reads when the source data changes (requires --measure-id, --time-scheme-id, --connection-id; optionally --interval-type). One per calendar. Not the same as --attach-measure-time-scheme, which writes the refresh OFFSET. |
--attachment-type-id |
int? |
|
Attachment type ID (for attachment segments) |
--attribute-lock |
string |
|
Set the model attribute value lock (true|false) when setting it. Only applies to template entities; omit to leave any existing lock unchanged. |
--attribute-name |
string |
|
Model attribute name |
--attribute-type |
string |
|
Event attribute type: manual, calculation, or segment |
--attribute-value |
string |
|
Model attribute value; also the attribute value an event-scheme trigger matches on (EventTriggerEventScheme.AttributeValue) |
--auto-confirm |
flag |
|
Auto-confirm all prompts |
--backfill |
flag |
|
Set backfill date on measures (requires --entity-type folder|metric|eventscheme|measure, --entity-id, --backfill-date) |
--backfill-date |
string |
|
Backfill date (yyyy-MM-dd or yyyy-MM-dd HH:mm, UTC) |
--backup |
flag |
|
Perform a backup of an Infohub instance (--host, --database, --user, --password) |
--batch-file |
string |
|
Path to a file listing the entities to process, one per line, for the batch template verbs |
--batch-update-from-template |
flag |
|
Update many entities from their templates in one pass (requires --entity-type and either --entity-ids-file or --batch-file; add --continue-on-error to keep going past a failure) |
--bootstrap-port |
int? |
|
Port of the Flow Bootstrap service (default 4501) |
--bulk-create-aggregation |
flag |
|
Bulk create aggregation measures under a metric (requires --metric-id; optionally --interval-types, --aggregation-types) |
--bulk-create-retrieved |
flag |
|
Bulk create retrieved measures under a metric (requires --metric-id; optionally --interval-types) |
--bulk-set-model-attributes |
flag |
|
Bulk add/update model attributes from --model-attributes or --model-attributes-file |
--calculation-datetime |
string |
|
DateTime for --add-measure-calculation history row (ISO8601 UTC; must not be BeginningOfTime) |
--chart-component-id |
int? |
|
ChartComponent ID |
--chart-component-property-name |
string |
|
ChartComponentProperty name |
--chart-component-property-value |
string |
|
ChartComponentProperty value |
--chart-component-type-id |
int? |
|
ChartComponentType ID |
--chart-constructor |
string |
|
Named factory constructor for --create-chart (e.g. Hourly, Daily, Title, Tag). Omit to use the factory's only constructor; the error message lists valid names. |
--chart-id |
int? |
|
Chart ID |
--chart-item-id |
int? |
|
ChartItem ID |
--chart-item-property-name |
string |
|
ChartItemProperty name |
--chart-item-property-value |
string |
|
ChartItemProperty value |
--chart-item-type-id |
int? |
|
ChartItemType ID |
--chart-property-name |
string |
|
Chart property name |
--chart-property-value |
string |
|
Chart property value |
--chart-type-id |
int? |
|
ChartType ID |
--cleanup-delinked |
flag |
|
Remove delinked properties from template instances (requires --entity-type, --entity-id, --property-type, --target-id) |
--clear-expired-sessions |
flag |
|
Clear all expired server sessions |
--clear-unused-modules |
flag |
|
Remove all unused modules/packages from an Infohub instance (--host, --database, --user, --password) |
--color |
string |
|
Hex color (e.g. #10B981) |
--column-enumeration-ids |
string |
|
Comma-separated Enumeration IDs to seed EnumerationGroupColumn rows (e.g. "3,5,7") |
--command-timeout |
int |
|
Command timeout in seconds |
--comparator-type |
string |
|
Comparator type for measure limit attach (e.g. GreaterThan, LessThan, Equal, NotEqual) |
--complete |
string |
|
Return tab-completions for the given partial input string (used by the embedded terminal). |
--component-id |
int? |
|
Deployment component ID |
--component-type |
string |
|
Deployment component type: platform, engine, message-engine, integration-engine, server, connection, consumer, notification-server; for --delete-component also message-channel, message-definition |
--conflict-handling |
string |
|
Conflict handling: Skip, Overwrite, Rename (default: Skip for --import, Rename for --instantiate/--derive/--create-template) |
--connection-definition |
string list |
|
Simulator definition files per connection for --import-model: 'ConnectionName=path.xml'. Applied after import — wraps the XML and sets the Definition property on the named connection. |
--connection-id |
int? |
|
Connection ID for --create-measure --retrieval-type retrieved |
--connection-property |
string |
|
Connection plugin property overrides for --create-connection, as comma-separated Key=Value pairs |
--connection-security |
string |
|
SQL connection encryption: Optional (default), Mandatory or Strict |
--connection-timeout |
int |
|
Specify the SQL connection timeout in seconds |
--connection-type-id |
int? |
|
ConnectionType ID used by --create-connection |
--consumer-id |
int? |
|
Consumer ID |
--consumer-property |
string |
|
Consumer plugin property overrides as comma-separated Key=Value pairs |
--consumer-type-id |
int? |
|
ConsumerType ID |
--continue-on-error |
flag |
|
Keep processing the remaining entities when one fails, instead of stopping at the first error (batch template verbs) |
--copy-attributes |
flag |
|
When attaching an EventScheme to a Measure, also create MeasureEventSchemeAttribute rows for every attribute in the event scheme |
--copy-consumers-from |
int? |
|
Source measure ID to copy consumers from (for bulk create operations) |
--copy-contexts |
flag |
|
Copy contexts (time schemes, event schemes) to instances |
--copy-dependencies |
flag |
|
Copy dependencies to instances |
--create |
flag |
|
Create a new Infohub instance (--host, --database, --name, --user, --password) |
--create-chart |
flag |
|
Create a Chart via its factory (requires --name, --chart-type-id, and --report-folder-id or --dashboard-id; optional --chart-constructor, --time-scheme-id) |
--create-chart-component-type |
flag |
|
Create (idempotent by name) a ChartComponentType lookup row (requires --name) |
--create-chart-item-type |
flag |
|
Create (idempotent by name) a ChartItemType lookup row (requires --name) |
--create-connection |
flag |
|
Create a new data source Connection (requires --name, --connection-type-id; optional --platform-id, --connection-property Key=Value,Key=Value) |
--create-consumer |
flag |
|
Create a new consumer (requires --name, --consumer-type-id; optional --platform-id) |
--create-dashboard |
flag |
|
Create a Dashboard (requires --name, --report-folder-id) |
--create-dashboard-loop |
flag |
|
Create a dashboard loop (requires --name; optional --report-folder-id) |
--create-engine |
flag |
|
Create a new data engine (requires --name, --platform-id) |
--create-enumeration |
flag |
|
Create a new enumeration (requires --name, --enumeration-type fixed|lookup) |
--create-enumeration-group |
flag |
|
Create a new enumeration group (requires --name; optionally --enumeration-group-type-id, --column-enumeration-ids) |
--create-event-scheme |
flag |
|
Create a new EventScheme (requires --name, --metric-folder-id; optionally --view-type) |
--create-function |
flag |
|
Create a new function (requires --name; optionally --function-folder-id) |
--create-function-folder |
flag |
|
Not available in this release. Create a function folder. Existing folders can still be renamed or deleted with the toolbox-item options |
--create-group |
flag |
|
Create an access control group (requires --name) |
--create-integration-engine |
flag |
|
Create a new integration engine (requires --name, --platform-id) |
--create-limit |
flag |
|
Create a new limit (requires --name, --limit-type-id) |
--create-measure |
flag |
|
Create a new Measure (requires --name, --interval-type, --retrieval-type, and --metric-id or --event-scheme-id) |
--create-message-channel |
flag |
|
Create a new message channel (requires --name, --message-engine-id; optional --message-channel-type system|retrieved) |
--create-message-definition |
flag |
|
Create a new message definition (requires --name, --message-channel-id) |
--create-message-engine |
flag |
|
Create a new message engine (requires --name, --platform-id) |
--create-metric |
flag |
|
Create a new Metric (requires --name, --metric-folder-id; optionally --engine-id, --view-type, --instance-name) |
--create-metric-folder |
flag |
|
Create a new MetricFolder (requires --name; optionally --parent-id, --view-type) |
--create-model-attribute |
flag |
|
Create a new model attribute (requires --name; optionally --model-attribute-folder-id) |
--create-model-attribute-folder |
flag |
|
Not available in this release. Create a new model attribute folder (requires --name) |
--create-notification-server |
flag |
|
Create a new notification server (requires --name, --notification-server-type-id; optional --platform-id) |
--create-palette |
flag |
|
Create a new palette (requires --name; optionally --palette-colors) |
--create-platform |
flag |
|
Create a new platform. A Platform is identified by its HOST, so --name must be a hostname, IP address or base URL (e.g. localhost, FLSW01, https://flow.example.com:4501) - NOT a friendly name, because server and data-source URLs are built from it (requires --name) |
--create-report-folder |
flag |
|
Create a ReportFolder (requires --name; optional --parent-id) |
--create-server |
flag |
|
Create a new server (requires --name, --platform-id) |
--create-server-key |
flag |
|
Create a server key record (requires --server-id, --name; optional --group-id, --expiry). It does not issue a token that a caller can authenticate with; use --create-server-token for that |
--create-server-token |
flag |
|
Obtain a server token from this instance's running Flow Server and store the matching ServerKey row (requires --server-id, --name, --token-user, --token-password; optional --group-id, --expiry (sets the TOKEN's own lifetime, clamped by the server to ten years, and the matching row), --platform-id, --bootstrap-port (default 4501), --use-https). Prints the token, which a subscriber consumes via --create-template-server --template-server-key |
--create-shift |
flag |
|
Create a new shift definition (requires --name) |
--create-shift-scheme |
flag |
|
Create a new shift scheme (requires --name, --time-scheme-id; optionally --effective-date, --shift-scheme-instances) |
--create-tag-transform |
flag |
|
Create a Tag Transform measure (timestamp + aggregation wrapper) around a source measure or event scheme |
--create-template |
flag |
|
Promote an existing model entity into a template. The destination must be a TEMPLATE-side folder (TemplateFolder/TemplateMetricFolder) - model folders are refused (requires --source-entity-type MetricFolder|Metric|EventScheme, --source-entity-id, --destination-entity-type, --destination-entity-id) |
--create-template-folder |
flag |
|
Create a new TemplateFolder row (requires --name; optionally --parent-id) |
--create-template-server |
flag |
|
Create a TemplateServer link to a publishing instance (requires --template-server-name, --template-server-host, --template-server-instance; optional --template-server-port (default 4501), --template-server-key) |
--create-time-scheme |
flag |
|
Create a new time scheme/calendar (requires --name) |
--create-user |
flag |
|
Create a username record (requires --name) |
--culture |
string |
|
Specify the culture to be used when creating a new Infohub instance (defaults to local culture) |
--dashboard-description |
string |
|
Dashboard description |
--dashboard-id |
int? |
|
Dashboard ID |
--dashboard-loop-id |
int? |
|
Dashboard loop ID |
--dashboard-panel-id |
int? |
|
DashboardPanel ID |
--dashboard-title |
string |
|
Dashboard title |
--database |
string |
|
Specify the Infohub instance database name |
--definition |
string |
|
C# source definition for a function (used with --create-function or --set-function-body) |
--definition-file |
string |
|
Path to a simulator definition XML file for --create-connection. Wraps the file in SimulatorFile format and writes it to the Definition property. |
--delete-chart |
flag |
|
Delete a chart and its whole tree, dashboard panels and usage rows. Refuses if the chart is a template with instances, is embedded by other charts, or is used by message segments — --force delinks/clears those references first (requires --chart-id) |
--delete-chart-node |
flag |
|
Delete a component or item from a chart, honouring the chart type's CanDelete rules; rows the factory cannot load (illegal placement/unknown type) are removed via a raw-row fallback (requires --chart-component-id or --chart-item-id) |
--delete-component |
flag |
|
Delete a deployment component (requires --component-type and --component-id) |
--delete-dashboard-panel |
flag |
|
Remove a DashboardPanel from its dashboard (requires --dashboard-panel-id). The chart itself is not deleted. |
--delete-entity |
flag |
|
Delete an entity (requires --entity-type folder|metric|eventscheme|measure, --entity-id; use --force for entities with children) |
--delete-group |
flag |
|
Delete an access control group (requires --group-id) |
--delete-server-key |
flag |
|
Delete a server key (requires --server-key-id) |
--delete-toolbox-item |
flag |
|
Delete a toolbox item (requires --toolbox-type and --toolbox-id) |
--delink-entity |
flag |
|
Remove the template link from an entity (requires --entity-type folder|metric|eventscheme|measure, --entity-id) |
--dependency-event-attribute-ids |
string |
|
Comma-separated dependency event attribute IDs for calculation event attributes |
--dependency-measure-ids |
string |
|
Comma-separated dependency measure IDs for calculation measures |
--dependency-measure-refs |
string |
|
Calc deps with optional relative periods, e.g. '109@-7:0,110' — id[@r[:rs]] |
--deploy |
flag |
|
Deploy a component (requires --component-type and --component-id) |
--deployed-only |
flag |
|
Show only deployed components |
--deployment-status |
flag |
|
Show full deployment overview across all platforms |
--derive |
flag |
|
Derive new template entities from existing templates (alias for instantiate with InstantiateToModel=false) |
--description |
string |
|
Entity description |
--destination-entity-id |
int? |
|
Destination entity ID (parent container) |
--destination-entity-name |
string |
|
Destination entity name |
--destination-entity-type |
string |
|
Destination entity type (parent container) |
--destination-id |
int? |
|
Destination entity ID |
--destination-parent-id |
int? |
|
Destination parent MetricFolder ID (omit for root level) |
--destination-type |
string |
|
Destination type: MetricFolder, Metric, EventScheme |
--display-order |
int? |
|
Display order for new component/panel rows |
--display-period |
int? |
|
Display period in seconds for dashboard in loop (default: 30) |
--dry-run |
flag |
|
Show what would be updated without making changes |
--duration |
string |
|
Relative time window, e.g. 12h, 3d, 2w, 1m (default: 24h) |
--effective-date |
string |
|
Shift scheme effective datetime (ISO8601, e.g. 2026-03-01T05:00:00Z) |
--embed-chart-id |
int? |
|
Chart ID this component embeds/links to (ChartComponentDetail.ChartID — e.g. a report link). Must differ from --chart-id. |
--embed-dashboard-id |
int? |
|
Dashboard ID this component embeds/links to (ChartComponentDetail.DashboardID — e.g. a report link). |
--enable-auto-mapping |
flag |
|
Enable auto-mapping by name/ID |
--end-time |
string |
|
Absolute end time (yyyy-MM-dd or yyyy-MM-dd HH:mm, default: now) |
--engine-id |
int? |
|
Engine ID |
--entity-id |
int? |
|
Entity ID to update |
--entity-ids |
string |
|
Comma-separated list of entity IDs |
--entity-ids-file |
string |
|
Path to a file of entity IDs, one per line, used by the batch template verbs instead of repeating --entity-id |
--entity-type |
string |
|
Entity type: Metric, MetricFolder, EventScheme, Measure, Chart (Chart applies to --release/--unrelease) |
--enumeration-group-id |
int? |
|
EnumerationGroup ID |
--enumeration-group-type-id |
int |
|
EnumerationGroupType ID (1=Fixed, 2=Lookup). Default: 1 (Fixed). |
--enumeration-id |
int? |
|
Enumeration ID |
--enumeration-query |
string |
|
SQL query for lookup enumeration (must return Ordinal and Value columns) |
--enumeration-type |
string |
|
Enumeration type: fixed or lookup |
--event-aggregation-type |
string |
|
Event aggregation type for aggregation measures over event schemes (default: CountStart) |
--event-attribute-id |
int? |
|
EventAttribute ID for --add-event-attribute-segment |
--event-scheme-id |
int? |
|
EventScheme ID |
--event-trigger-id |
int? |
|
EventTrigger ID |
--event-trigger-type |
string |
|
Event trigger type: Start or End (default: Start if missing, otherwise End) |
--eventlog |
flag |
|
Not available in this release. Show recent Windows Event Log entries from Infohub sources (--duration, --log-level, --search-text) |
--execute-filter |
flag |
|
Not available in this release. Execute a filter expression to return matching entity IDs |
--expiry |
string |
|
Expiry date (ISO 8601 format) |
--export-file |
string |
|
Output file path for export (.flowMdl) |
--export-model |
flag |
|
Export model to a .flowMdl file (--export-file, --export-type) |
--export-type |
string |
|
Export type: full, model, templates, reports, toolbox |
--expression |
string |
|
Expression for calculation measures (default: Measure_.Value * 1.0 or 0.0) |
--file |
string |
|
Specify the path of a file |
--filter-expression |
string |
|
Filter expression using C# syntax |
--folder |
string |
|
Specify the path of a folder |
--force |
flag |
|
Force delete even if entity has children |
--format |
string |
|
Display format string |
--function-folder-id |
int? |
|
Function folder ID |
--function-id |
int? |
|
Function ID |
--gap-skip-to |
flag |
|
Advance an event scheme's processing pointer past a data gap (requires --entity-type eventscheme, --entity-id, --gap-skip-to-date) |
--gap-skip-to-date |
string |
|
Target date to skip forward to (yyyy-MM-dd or yyyy-MM-dd HH:mm, UTC) |
--get-system-property |
flag |
|
Get a system property value (requires --property-name) |
--grant-folder-permission |
flag |
|
Grant group access to a folder (requires --group-id, plus --metric-folder-id or --report-folder-id) |
--grant-measure-permission |
flag |
|
Grant group permission on a measure (requires --group-id, --measure-id) |
--group-id |
int? |
|
Group ID |
--health |
flag |
|
Not available in this release. Run a health check on the instance (database, engines, logs, processing) |
--high |
double? |
|
Limit high value |
--host |
string |
|
Specify the SQL Server instance name |
--host-name-in-certificate |
string |
|
Host name expected in the SQL Server certificate (when it differs from --host) |
--ignore-missing-dependencies |
flag |
|
Ignore unmapped dependencies |
--image-height |
int? |
|
Image height for attachment (default: 1080) |
--image-timeout |
int? |
|
Image timeout ms for attachment (default: 30000) |
--image-width |
int? |
|
Image width for attachment (default: 1920) |
--import |
flag |
|
Import a module (--file) or modules (--folder) into an Infohub instance (--host, --database, --user, --password) |
--import-definition |
flag |
|
Not available in this release. Import a Definition JSON file into a connection or consumer (requires --component-type, --name or --component-id, and --file) |
--import-destination-id |
int? |
|
MetricFolder ID to import into (default: top-level model folder) |
--import-file |
string |
|
Path to .flowMdl file |
--import-model |
flag |
|
Import model from flowMdl file |
--import-type |
string |
|
Import type: full, model, templates, reports, toolbox |
--include-children |
flag |
|
Include child entities of the ones selected (e.g. the metrics and measures under a MetricFolder) when scanning for out-of-sync entities |
--include-optional |
string |
|
Comma-separated optional template member IDs or names to INCLUDE when instantiating/deriving. Opt-in: optional members are excluded by default. Use 'all' to include every optional member. |
--inherited |
flag |
|
Mark ModelAttribute value as inherited |
--instance-count |
int |
|
Number of instances to create (default: 1) |
--instance-name |
string |
|
Instance name pattern for the metric (e.g. a ModelAttribute expression) |
--instances |
int |
|
Number of instances to create |
--instantiate |
flag |
|
Instantiate template entities to model or template entities |
--instantiate-to-model |
flag |
|
Instantiate to Model view (true) or Template view (false) |
--integrated-security |
flag |
|
Use Windows authentication |
--interval-count |
int? |
|
Interval count |
--interval-start |
int? |
|
Interval start position |
--interval-start-interval-type |
string |
|
Interval type the calendar trigger's interval starts on (defaults to --interval-type) |
--interval-type |
string |
|
Interval type: timestamp, minutely, hourly, shiftly, daily, weekly, monthly, quarterly, yearly |
--interval-type-id |
int? |
|
IntervalType ID for message trigger |
--interval-types |
string |
|
Comma-separated interval types for bulk operations: timestamp,minutely,hourly,shiftly,daily,weekly,monthly,quarterly,yearly |
--is-heading |
flag |
|
Mark segment as heading |
--is-subject |
flag |
|
Mark section as subject line |
--item-description |
string |
|
Data source item description override |
--item-name |
string |
|
Data source item name (tag path / query / namespace item) for retrieved measures |
--item-property |
string |
|
Data source item plugin property overrides as comma-separated Key=Value pairs |
--item-reference |
string |
|
Data source item reference |
--item-uom |
string |
|
Data source item UOM override (default: measure UOM) |
--key |
string |
|
Specify the license key to be used |
--label |
string |
|
Label for access control group |
--license |
flag |
|
Update the license key (--key) of an Infohub instance (--host, --database, --user, --password) |
--limit-colors |
string |
|
Limit color overrides as Key=Value pairs, comma-separated (e.g. "ChartColorHigh=#F43F5E,ChartColorLow=#F59E0B") |
--limit-datetime |
string |
|
MeasureLimit.DateTime (ISO8601 UTC) for --attach-measure-limit (default: BeginningOfTime) |
--limit-id |
int? |
|
Limit ID |
--limit-instance-datetime |
string |
|
MeasureLimitInstance.DateTime (ISO8601 UTC) |
--limit-type-id |
int? |
|
Limit type ID |
--limit-value-high |
double? |
|
Constant High value for MeasureLimitValueProperty |
--limit-value-low |
double? |
|
Constant Low value for MeasureLimitValueProperty |
--limit-value-target |
double? |
|
Constant Target value for MeasureLimitValueProperty |
--link-entity |
flag |
|
Link a model entity to a template (requires --entity-type folder|metric|eventscheme|measure, --entity-id, --template-id) |
--link-message-notification-server |
flag |
|
Link a notification server to a message definition (requires --message-definition-id, --notification-server-id) |
--list-chart-component-properties |
flag |
|
List properties on a chart component (requires --chart-component-id) |
--list-chart-item-properties |
flag |
|
List properties on a chart item (requires --chart-item-id) |
--list-chart-node-options |
flag |
|
List what the chart type allows adding under a node — child components/items with their type IDs, and link placeholders (requires --chart-component-id or --chart-item-id; supports --output-format json) |
--list-chart-node-properties |
flag |
|
List the FULL configurable property surface of a chart/component/item — names, categories, types, current values, valid values, visibility conditions (requires --chart-id, --chart-component-id or --chart-item-id; supports --output-format json) |
--list-chart-properties |
flag |
|
List properties on a chart (requires --chart-id) |
--list-chart-tree |
flag |
|
Print the full component/item hierarchy of a chart with IDs, types, section and series titles, bindings and display order (requires --chart-id; supports --output-format json) |
--list-chart-types |
flag |
|
List available chart types (including Form types) |
--list-charts |
flag |
|
List charts (optionally --report-folder-id) |
--list-connection-properties |
flag |
|
List properties of a connection (requires --connection-id) |
--list-connection-schema |
flag |
|
List plugin properties for a Connection (requires --connection-id; optional --target measure|tag|trigger|segment) |
--list-connection-type-schema |
flag |
|
Reflect plugin properties for a connection type (requires --connection-type-id; optional --target measure|tag|trigger|segment) |
--list-connection-types |
flag |
|
List available connection types (data source plugins) |
--list-connections |
flag |
|
List data connections/sources (optionally filter by --platform-id or --platform-name) |
--list-consumers |
flag |
|
List consumers (optionally filter by --platform-id or --platform-name) |
--list-dashboard-loops |
flag |
|
List all dashboard loops |
--list-dashboard-panels |
flag |
|
List a dashboard's panels with their IDs and geometry (requires --dashboard-id) |
--list-dashboards |
flag |
|
List dashboards (optionally --report-folder-id) |
--list-datasource-namespace |
flag |
|
Browse the data source namespace exposed by a Connection (requires --connection-id; optional --parent-path, --search) |
--list-delinked |
flag |
|
List delinked properties on template instances (requires --entity-type folder|metric|eventscheme, --entity-id) |
--list-engines |
flag |
|
List data engines (optionally filter by --platform-id or --platform-name) |
--list-enumerations |
flag |
|
List all enumerations |
--list-event-attribute-values |
flag |
|
List attribute value options for an event attribute (requires --event-attribute-id) |
--list-event-attributes |
flag |
|
List an EventScheme's attributes with their IDs (requires --event-scheme-id; optionally --measure-id to show only those in that measure's event-attribute context) |
--list-event-schemes |
flag |
|
List EventSchemes (optionally --metric-folder-id, --view-type) |
--list-folder-permissions |
flag |
|
List folder-group permissions (optional --group-id) |
--list-formats |
flag |
|
List all display formats |
--list-functions |
flag |
|
List all functions |
--list-group-members |
flag |
|
List members of a group (requires --group-id) |
--list-groups |
flag |
|
List all access control groups |
--list-integration-engines |
flag |
|
List integration engines (optionally filter by --platform-id or --platform-name) |
--list-interval-types |
flag |
|
List all interval types |
--list-limits |
flag |
|
List all limits |
--list-locks |
flag |
|
List locks on a template entity (requires --entity-type, --entity-id) |
--list-measure-limits |
flag |
|
List MeasureLimit LINKS - the measure-to-limit rows, not the Limit rows - and report the MeasureLimitID that --update-chart-item-limit and --add-chart-item need (requires --measure-id, --limit-id, or both) |
--list-measure-permissions |
flag |
|
List measure-group permissions (optional --group-id or --measure-id) |
--list-measures |
flag |
|
List Measures (optionally --metric-id, --event-scheme-id, --view-type) |
--list-message-definitions |
flag |
|
List message definitions |
--list-message-engines |
flag |
|
List message engines (optionally filter by --platform-id or --platform-name) |
--list-metric-folders |
flag |
|
List MetricFolders (optionally --parent-id, --view-type) |
--list-metrics |
flag |
|
List Metrics (optionally --metric-folder-id, --view-type) |
--list-model-attributes |
flag |
|
List all model attributes |
--list-notification-servers |
flag |
|
List notification servers (optionally filter by --platform-id or --platform-name) |
--list-optional |
flag |
|
List the optional members of the source template (use with --source-entity-type/-id or -name) instead of instantiating |
--list-out-of-sync |
flag |
|
List entities whose TemplateVersion differs from their template's current Version (requires --entity-type Metric|MetricFolder|EventScheme|Measure; covers both local templates and template-server templates) |
--list-palettes |
flag |
|
List all color palettes |
--list-platforms |
flag |
|
List all platforms with deployment status |
--list-properties |
flag |
|
List properties of a deployment component (requires --component-type and --component-id) |
--list-quick-actions |
flag |
|
List available quick action commands |
--list-report-folders |
flag |
|
List report folders |
--list-server-key-usage |
flag |
|
List server key usage (requires --server-key-id; optional --duration) |
--list-server-keys |
flag |
|
List server keys (optional --server-id) |
--list-server-sessions |
flag |
|
List active server sessions (optional --server-id) |
--list-servers |
flag |
|
List servers (optionally filter by --platform-id or --platform-name) |
--list-shift-scheme-intervals |
flag |
|
List intervals in a shift scheme (requires --shift-scheme-id) |
--list-shift-schemes |
flag |
|
List all shift schemes |
--list-shifts |
flag |
|
List all shift definitions |
--list-system-properties |
flag |
|
List all system properties |
--list-time-scheme-properties |
flag |
|
List TimeScheme configuration (requires --time-scheme-id) |
--list-time-schemes |
flag |
|
List all time schemes/calendars |
--list-units |
flag |
|
List all units of measure |
--list-users |
flag |
|
List all usernames |
--lock-property |
string |
|
Lock property name: name|description|format|uom|projected|retrievaltype|defaultvalue|initialvalue|instantiatedname |
--log-file |
string |
|
Write output to log file |
--log-level |
string |
|
Filter by level: Information, Warning, Error (default: all) |
--log-type |
string |
|
Filter by log category: System, Measure, Metric, Chart, Connection, Dashboard, Engine, EventScheme, Form, MessageDefinition, Report, Server, TemplateMeasure, TemplateMetric, TemplateMetricFolder (default: all) |
--logfile |
string |
|
Specify the path of a log file |
--logs |
flag |
|
Display change logs from the instance (--log-type, --duration, --start-time, --end-time, --log-level) |
--low |
double? |
|
Limit low value |
--manual-data-type |
string |
|
EventAttributeDefaultType for manual event attributes: value|previous|enumeration|enumerationGroup |
--map-connection |
string list |
|
Connection mappings: 'SourceName=TargetName' (use '=*' for create-new) |
--map-consumer |
string list |
|
Consumer mappings: 'SourceName=TargetName' |
--map-engine |
string list |
|
Engine mappings: 'SourceName=TargetName' |
--map-group |
string list |
|
Group mappings: 'SourceName=TargetName' |
--map-integration-engine |
string list |
|
Integration engine mappings: 'SourceName=TargetName' |
--map-limit |
string list |
|
Limit mappings: 'SourceName=TargetName' |
--map-location |
string list |
|
Location mappings: 'SourceName=TargetName' |
--map-palette |
string list |
|
Palette mappings: 'SourceName=TargetName' |
--map-template-server |
string list |
|
Template server mappings: 'SourceName=TargetName' |
--map-time-scheme |
string list |
|
Time scheme mappings: 'SourceName=TargetName' |
--mapping-file |
string |
|
JSON file with dependency mappings |
--measure-id |
int? |
|
Measure ID |
--measure-limit-id |
int? |
|
MeasureLimit ID to bind on a chart item (ChartItemDetail.MeasureLimitID) |
--measure-property-datatype |
string |
|
DataType for the MeasureProperty (default: auto-detect from value) |
--measure-property-name |
string |
|
Name of the MeasureProperty to set |
--measure-property-type |
string |
|
PropertyType: status|configuration|hidden|designonly (default: configuration) |
--measure-property-value |
string |
|
Value for the MeasureProperty |
--message-channel-id |
int? |
|
MessageChannel ID |
--message-channel-type |
string |
|
Message channel type. Default 'retrieved' - the user-authorable kind, the only kind the GUI creates. 'system' is refused: System channels are product-seeded and the GUI can neither create nor delete them |
--message-definition-id |
int? |
|
MessageDefinition ID |
--message-delay |
int? |
|
Delay in seconds before sending message after trigger |
--message-engine-id |
int? |
|
MessageEngine ID |
--message-section-id |
int? |
|
MessageSection ID |
--message-segment-type |
string |
|
Segment type: text|measure-value|measure-attribute|event-period|event-attribute|event-value|report|dashboard|attachment |
--message-trigger-type |
string |
|
Trigger type: time-period-start|time-period-end|event-period-start|event-period-end|measure-exception |
--metric-folder-id |
int? |
|
MetricFolder ID |
--metric-folder-type |
int? |
|
Filter by MetricFolderType (1=Model, 2=Template) |
--metric-id |
int? |
|
Metric ID |
--migrate |
flag |
|
Migrate an Infohub instance (--host, --database, --user, --password) |
--minute-interval |
int |
|
Minute interval for time scheme (default: 1) |
--model-attribute-folder-id |
int? |
|
Model attribute folder ID |
--model-attribute-id |
int? |
|
ModelAttribute ID for --set-model-attribute-value |
--model-attribute-patterns |
string |
|
Model attribute patterns: 'Region=North{0},Year=202{0}' |
--model-attribute-value |
string |
|
Value for --set-model-attribute-value |
--model-attributes |
string |
|
Model attributes as key=value pairs, comma-separated |
--model-attributes-file |
string |
|
JSON file with model attributes |
--monitor-status |
flag |
|
Show processing status summary for all deployed measures (counts by type/interval, pending, backfilling, stale) |
--move-folder |
flag |
|
Move a MetricFolder to a new parent (requires --entity-id and --destination-parent-id) |
--name |
string |
|
Specify the Infohub instance name |
--naming-pattern |
string |
|
Naming pattern: 'Sales {0}', 'Region {0} - {1}' |
--naming-start |
int |
|
Starting number for {0} in pattern |
--no-auto-segment |
flag |
|
Suppress the auto-created default segment when --add-event-attribute --attribute-type segment is used (then append segments via --add-event-attribute-segment) |
--no-copy-properties |
flag |
|
Do NOT copy time schemes, event schemes, and limits from the source measure (default: off, i.e. properties are copied) |
--no-edit |
flag |
|
Deny edit permission (default: edit allowed) |
--no-scaffold |
flag |
|
Obsolete: charts are now created through their factory, which builds the correct default tree. Ignored. |
--no-view |
flag |
|
Deny view permission (default: view allowed) |
--notification-server-id |
int? |
|
NotificationServer ID |
--notification-server-type-id |
int? |
|
NotificationServerType ID |
--object-mapping-file |
string |
|
JSON file for object mapping (reports/charts/dashboards) |
--ordinal |
int? |
|
Ordinal index (integer) |
--ordinal-values |
string |
|
Comma-separated cell pairs: 'egcid=eoid' ids (e.g. "1=9,2=14") or 'ColumnName=OrdinalValue' names (e.g. "Fault Type=Inverter Trip,Severity=High") - names are resolved within the group. A pair that is valid both ways (a column named '3' and integer ids) is refused; state the intent with 'id:3=7' or 'name:3=7' |
--output-format |
string |
|
Output format: text, json, csv |
--page-number |
int |
|
Page number to retrieve (1-indexed, default: 1) |
--page-size |
int |
|
Number of entities per page (default: 200, use 0 for all) |
--palette-colors |
string |
|
Comma-separated hex colors (e.g. "#F59E0B,#FB923C,#FBBF24") |
--palette-id |
int? |
|
Palette ID for event attribute color |
--panel-height |
int? |
|
DashboardPanel height |
--panel-left |
int? |
|
DashboardPanel left position |
--panel-title |
string |
|
Panel title shown above the chart (empty string clears it) |
--panel-top |
int? |
|
DashboardPanel top position |
--panel-type |
int |
|
DashboardPanelType ID (default 1) |
--panel-width |
int? |
|
DashboardPanel width |
--parallelism |
int |
|
Max parallel operations (1-10) |
--parent-chart-component-id |
int? |
|
Parent ChartComponent ID (for nested components) |
--parent-chart-item-id |
int? |
|
Parent ChartItem ID for nested items (e.g. a limit or color provider under a measure item). Must belong to the same chart component. |
--parent-id |
int? |
|
Parent entity ID |
--parent-path |
string |
|
Filter namespace listing by parent path prefix (e.g. 'Site.Area') |
--password |
string |
|
Specify the SQL Password (defaults to integrated security) |
--platform-id |
int? |
|
Filter by platform ID |
--platform-name |
string |
|
Filter by platform name/host |
--propagate-definition |
flag |
|
Not available in this release. Propagate definition query changes to existing measure properties (requires --component-type and --name or --component-id) |
--propagate-format |
flag |
|
Propagate display format from a metric/folder to all child measures (requires --entity-type folder|metric, --entity-id, --format) |
--propagate-uom |
flag |
|
Propagate UOM from a metric/folder to all child measures (requires --entity-type folder|metric, --entity-id, --uom) |
--property-name |
string |
|
Property name to set |
--property-type |
string |
|
Property type for cleanup: consumer, connection, timescheme, limit |
--property-value |
string |
|
Property value to set |
--quiet |
flag |
|
Disable standard logging. |
--recursive |
flag |
|
With --update-from-template on a MetricFolder: also update every template-linked entity beneath it from its OWN template (the set --show-children reports). A folder with no template of its own is then walked as a container |
--refresh-backfill |
string |
|
MeasureTimeSchemeRefresh.Backfill (ISO8601 UTC) for --attach-measure-time-scheme |
--refresh-datetime |
string |
|
MeasureTimeSchemeRefresh.DateTime (ISO8601 UTC) for --attach-measure-time-scheme |
--refresh-offset |
int? |
|
MeasureTimeSchemeRefresh.RefreshOffset (seconds) for --attach-measure-time-scheme |
--refresh-template-server |
int? |
|
Verify one TemplateServer connection and load its template model (see --refresh-template-servers for the scope of a refresh) |
--refresh-template-servers |
flag |
|
Verify every TemplateServer connection and load its template model. The model is held for this command only - there is nothing to persist, and a running Config GUI keeps its own copy; the verbs that consume templates load it themselves |
--register-with-bootstrap |
flag |
|
Register the connected instance with the Flow Bootstrap service running on the platform's Host (NOT necessarily this machine - see --platform-id/--platform-name) so it will host that instance's deployed components. The instance's SQL connection details (including an encrypted password) are sent to that Bootstrap service. Optional --platform-id, --bootstrap-port (default 4501), --use-https |
--release |
flag |
|
Release a template entity and all its nested entities |
--release-new-entities |
flag |
|
Automatically release newly created entities after template update operations (default: true) |
--remove-group-member |
flag |
|
Remove a user from a group (requires --group-id, --username-id) |
--remove-loop-dashboard |
flag |
|
Remove a dashboard from a loop (requires --dashboard-loop-id, --dashboard-id) |
--remove-shift-scheme-interval |
flag |
|
Remove an interval from a shift scheme (requires --shift-scheme-interval-id) |
--rename-entity |
flag |
|
Rename an entity (requires --entity-type folder|metric|eventscheme|measure, --entity-id, --name) |
--rename-toolbox-item |
flag |
|
Rename a toolbox item (requires --toolbox-type, --toolbox-id, --name) |
--reorder-entity |
flag |
|
Set DisplayOrder on an entity (requires --entity-type folder|metric|eventscheme|measure|chartcomponent|chartitem, --entity-id, --display-order) |
--report-folder-id |
int? |
|
ReportFolder ID |
--reset |
flag |
|
Reset the license to demo (use with --license to reset and display new details) |
--retrieval-type |
string |
|
Retrieval type: manual, retrieved, aggregation, calculation, replicated |
--reuse-existing-mappings |
flag |
|
Reuse existing relationships (default: true) |
--revoke-folder-permission |
flag |
|
Revoke group access to a folder (requires --group-id, plus --metric-folder-id or --report-folder-id) |
--revoke-measure-permission |
flag |
|
Revoke group permission on a measure (requires --group-id, --measure-id) |
--revoke-server-key |
flag |
|
Revoke a server key by setting expiry to now (requires --server-key-id) |
--search |
string |
|
Search filter for namespace listing |
--search-text |
string |
|
Filter results by text search |
--segment-format |
string |
|
Format string for segment (e.g. yyyy for periodStart, 0000 for periodIndex) |
--segment-link |
string |
|
Hyperlink for message segment |
--segment-name |
string |
|
Segment Name |
--segment-offset |
int? |
|
Segment offset integer (default: 0) |
--segment-offset-type |
string |
|
Segment offset type (default: afterPeriodStart) |
--segment-text |
string |
|
Text content for message segment |
--segment-type |
string |
|
Segment type: constant|retrieved|periodIndex|periodStart|periodEnd |
--server-id |
int? |
|
Server ID |
--server-key-id |
int? |
|
Server key ID |
--set-chart-component-property |
flag |
|
Set a component configuration property via the chart's factory, validating name and value (requires --chart-component-id, --chart-component-property-name, --chart-component-property-value) |
--set-chart-item-property |
flag |
|
Set an item configuration property via the chart's factory, validating name and value (requires --chart-item-id, --chart-item-property-name, --chart-item-property-value) |
--set-chart-property |
flag |
|
Set a chart configuration property via the chart's factory, validating name and value (requires --chart-id, --chart-property-name, --chart-property-value) |
--set-connection-property |
flag |
|
Set a connection property (requires --connection-id, --property-name, --property-value) |
--set-enumeration-connection |
flag |
|
Link a lookup enumeration to a data source connection (requires --enumeration-id, --connection-id; optional --enumeration-query) |
--set-function-body |
flag |
|
Update an existing function's definition (requires --function-id, and --definition or --file) |
--set-lock |
flag |
|
Lock a property on a template entity (requires --entity-type, --entity-id, --lock-property; use --unlock to unlock) |
--set-measure-property |
flag |
|
Upsert a MeasureProperty row (requires --measure-id, --measure-property-name, --measure-property-value) |
--set-model-attribute |
flag |
|
Add or update a model attribute on an entity (requires --entity-type, --entity-id, --attribute-name, --attribute-value) |
--set-model-attribute-value |
flag |
|
Set a specific ModelAttribute value on an entity (requires --entity-type, --entity-id, --model-attribute-id, --model-attribute-value) |
--set-property |
flag |
|
Set a property value on a component (requires --component-type, --component-id, --property-name, --property-value) |
--set-system-property |
flag |
|
Set a system property value (requires --property-name, --property-value) |
--set-time-scheme-property |
flag |
|
Set a TimeScheme configuration property (requires --time-scheme-id, --property-name, --property-value) |
--shift-id |
int? |
|
Shift ID |
--shift-scheme-id |
int? |
|
ShiftScheme ID |
--shift-scheme-instances |
string |
|
Shift scheme interval tuples ShiftID:IntervalStart:IntervalCount, comma-separated (e.g. "1:1:96,2:97:96,3:193:96") |
--shift-scheme-interval-id |
int? |
|
ShiftSchemeInterval ID |
--show-children |
flag |
|
Show the child entities of each result as well as the entity itself |
--show-entity-details |
flag |
|
Show full entity details instead of just IDs |
--skip-expression-validation |
flag |
|
Skip calculation expression validation (currently always skipped from the CLI; flag suppresses the warning) |
--source-entity-id |
int? |
|
Source template entity ID |
--source-entity-name |
string |
|
Source entity name |
--source-entity-type |
string |
|
Source template entity type: MetricFolder, Metric, EventScheme, Measure |
--source-event-scheme-id |
int? |
|
Source EventScheme ID (for --create-measure --retrieval-type aggregation, or --create-tag-transform) |
--source-id |
int? |
|
Source entity ID (template) |
--source-measure-id |
int? |
|
Source Measure ID (for --create-measure --retrieval-type aggregation, or --create-tag-transform) |
--source-tag-id |
int? |
|
Source tag measure ID for --create-measure --retrieval-type retrieved (reads from an existing tag-interval measure instead of a Connection) |
--source-type |
string |
|
Source type: MetricFolder, Metric, EventScheme, Measure |
--start-time |
string |
|
Absolute start time (yyyy-MM-dd or yyyy-MM-dd HH:mm) |
--sync-all-model-view |
flag |
|
Synchronize ALL templates in Model View |
--sync-all-template-view |
flag |
|
Synchronize ALL templates in Template View |
--sync-hierarchy-aware |
flag |
|
Skip entities already updated by parent sync (default: true) |
--sync-linked-templates |
flag |
|
Sync templates linked to a TemplateServer |
--target |
string |
|
Retrieved target: measure or tag (default: inferred from interval type) |
--target-id |
int? |
|
Target ID to match (ConsumerID, ConnectionID, TimeSchemeID, or LimitID depending on --property-type) |
--template-id |
int? |
|
Template entity ID to link to |
--template-server-host |
string |
|
Template server HTTP host (NOT the SQL host - that is --host) |
--template-server-id |
int? |
|
Specific TemplateServer ID to sync |
--template-server-instance |
string |
|
Infohub instance name on the template server |
--template-server-key |
string |
|
Server key issued by the template server: the JWT printed by --create-server-token on the publisher (NOT the row value printed by --create-server-key, which nothing can authenticate with). Required to pull: the template API is [Authorize("ServerKey")] |
--template-server-name |
string |
|
Template server name |
--template-server-port |
int? |
|
Template server HTTP port (default 4501) |
--test-connection |
flag |
|
Test a data source connection (requires --connection-id) |
--time-scheme-id |
int? |
|
TimeScheme ID |
--time-scheme-locks |
string |
|
MeasureTimeScheme.Locks JSON string (default: {}) |
--timezone |
string |
|
Specify the time zone to be used when creating a new Infohub instance (defaults to local time zone) |
--token-password |
string |
|
Password for --token-user. Sent RSA-encrypted with the public key the server issues, exactly as the Config GUI does |
--token-user |
string |
|
Account used to authenticate when obtaining a server token. The Flow Server validates this against the WINDOWS account database of the machine it runs on, not against Infohub users; use 'user' or 'DOMAIN\user' |
--toolbox-id |
int? |
|
Toolbox item ID |
--toolbox-type |
string |
|
Toolbox item type: timescheme, shift, enumeration, limit, function, function-folder, model-attribute, model-attribute-folder |
--trigger-type-id |
int? |
|
TriggerType for an event-scheme trigger (EventTriggerEventScheme.TriggerTypeID) |
--trust-server-certificate |
flag |
|
Trust the SQL Server certificate without validating its chain |
--undeploy |
flag |
|
Undeploy a component (requires --component-type and --component-id) |
--undeployed-only |
flag |
|
Show only undeployed components |
--unlock |
flag |
|
Unlock (remove lock) instead of locking |
--unrelease |
flag |
|
Unrelease a template entity and all its nested entities |
--uom |
string |
|
Unit of measure |
--update-all-out-of-sync |
flag |
|
Update all entities where Version != TemplateVersion |
--update-chart-item-event-attribute |
flag |
|
Bind an EventAttribute to an existing event-attribute chart item (the MeasureEventAttributeItem the chart type materialises under a measure item - the context provider a Pareto groups by). The attribute must be in the event-attribute context of the measure bound on the parent item, so attach the event scheme to that measure with --attach-measure-event-scheme --copy-attributes first. Pass --event-attribute-id 0 to clear (requires --chart-item-id, --event-attribute-id) |
--update-chart-item-limit |
flag |
|
Bind a MeasureLimit to an existing limit chart item (e.g. the MeasureLimitItem the chart type materialises under a measure item). The limit must belong to the measure bound on the parent item. Pass --measure-limit-id 0 to clear the binding (requires --chart-item-id, --measure-limit-id) |
--update-chart-item-measure |
flag |
|
Swap the measure bound to an existing chart item, validated by the chart type (requires --chart-item-id, --measure-id) |
--update-dashboard-panel |
flag |
|
Move or resize a DashboardPanel (requires --dashboard-panel-id and at least one of --panel-left, --panel-top, --panel-width, --panel-height; optional --panel-title) |
--update-from-template |
flag |
|
Update entity from its template |
--update-instances-of |
flag |
|
Update all instances that use specified template(s) as their source |
--update-name |
flag |
|
Update an entity's name from its InstantiatedName pattern and current model attribute values (requires --entity-type folder|metric|eventscheme, --entity-id) |
--use-https |
flag |
|
Use https when contacting the Bootstrap service |
--user |
string |
|
Specify the SQL Username (defaults to integrated security) |
--username-id |
int? |
|
Username ID |
--value |
string |
|
Ordinal value / label |
--verbose |
flag |
|
Verbose output |
--verified |
flag |
|
Mark function as verified (Status=1) on creation |
--version |
flag |
|
Get the version of an Infohub Instance (--host, --database, --user, --password) |
--view-definition |
flag |
|
Not available in this release. View the Definition JSON for a connection or consumer (requires --component-type and --name or --component-id) |
--view-type |
string |
|
View context: model or template (default: model) |